processbehavior 0.4.0__tar.gz → 0.5.0__tar.gz

{processbehavior-0.4.0 → processbehavior-0.5.0}/CHANGELOG.md

@@ -7,6 +7,73 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.5.0] - 2026-10-29
+
+This release adds staged (phased) Xbar and S charts, computed per stage as Dr. Bishop
+specified (2026-10-18), with `phase_statistics()` for the numbers behind each stage on both
+chart families. A column of values with no time is now charted in the order received.
+
+### Added
+- **A bare response is charted in the order received.** `formulate(response=...)` with no time,
+  factors or plan used to be refused. The values are now numbered 1..N in an `Observation` column
+  (the same numbers as `obs_id`) and the study is exactly the one `time='Observation'` gives: a
+  single stream, ADS 2, X/mR, sigma from N − 1 moving ranges. An NA response keeps its place as an
+  empty cell. The design report adds `Time: received order (no time column given)`. If the data
+  already has an `Observation` column, formulate asks you to pass it as `time=` or rename it (#129).
+- **Phased limits on Xbar and S charts.** `execute(chart='Xbar', phased=True)` gives each factor
+  combination its own centre line and limits on one chart, drawn as stepped lines with a divider at
+  each change, the way phased X/mR already does for its lanes. Each phase is computed as a separate
+  Xbar/S analysis, exactly as `by=[time]` computes one chart per condition: the centre is the mean of
+  the phase's subgroup means, with its own S-bar and sigma-hat (10-12 manual Eqs 11-5, 11-8, 11-9,
+  11-16, 11-17). `by=['stage', time]` pools the other factors into the subgroup and phases on the
+  stage; the centre is then the mean of the pooled subgroup averages, as Dr. Bishop specified
+  (2026-10-18). On Wheeler's four-cavity thickness data the per-cavity centres and limits match
+  Minitab's staged Xbar-S chart. Residual values, calibrations and `by=[time]` are refused with
+  messages that say what to use instead; a phase with no replicated subgroup keeps its points without
+  limits and is named in `metadata['insufficient_phases']`. (#144)
+- **`result.phase_statistics(chart, stratum=None)`.** One row per phase of a phased chart. Xbar/S:
+  `phase`, `subgroups`, `N`, `center`, `s_bar`, `sigma_hat`, `lpl`, `upl`. X/mR: `phase`, `points`,
+  `center`, `mR_bar`, `lpl`, `upl`, per stratum on a stratified chart (`stratum=`, or through
+  `focus()`). (#144)
+- **Docs: a Staged Charts tutorial**, executed in CI. On the bundled coffee-shop data, with the
+  stage derived by one `.bin()` call, it compares one set of limits with limits per stage on Xbar
+  and S, reads `phase_statistics()`, puts every reading on a phased X/mR chart, and pools or splits
+  a second factor. The chart-types guide's staged example now runs as written, and its pooling
+  example uses a study that has a factor to pool. (#144)
+
+### Changed
+- **`formulate(response=..., factors=[])` with no time is the same study.** It used to treat the
+  whole column as one replicated cell: ADS 1, a recommended one-point Xbar chart, the "within-cell
+  replication" series-length line, and an X chart plotted against the response values. Its chart
+  tables now start with `Observation` (#129).
+- **Xbar and S chart data carry `n`.** `get_chart('Xbar')` / `get_chart('S')`, and the Excel chart
+  sheets, gain an `n` column after the subgroup label. Unstratified Xbar/S metadata names the label
+  column as `group_col` (#143).
+- **Lane dividers on an Xbar or S chart are labelled with the phase.** These charts have no time
+  column and so no cell band under the axis, which is where X charts name their lanes. (#144)
+- **Phased chart data and `chart_table` carry a `phase` column** (the lane label) after the subgroup
+  label, on X/mR as well as Xbar/S. Phased Xbar/S metadata carries `phase_by`, `lane_boundaries`,
+  `single_point_phases` and `insufficient_phases`; `n_avg` is not reported on a phased chart, whose
+  `n_mode='average'` is applied per phase, so the per-phase mean size is `phase_statistics(chart)['N']`.
+  (#144)
+
+### Fixed
+- **Xbar/S `chart_table` keeps the subgroup label and `n` on every `by=`.** With a `by=` other than
+  time alone, such as a pooled subset (`by=['FACTOR 1', time]`), all factors, factors without time,
+  or one factor, the table dropped both columns, so a row couldn't be traced to its subgroup and
+  stepped limits went unexplained. `n` is now the aggregation's own count, which covers every cell
+  a pooled subgroup spans. This also corrects one row on residual charts whose limits rest on R2
+  (R1, R3, R4, R5) in a design with singletons: the stream's first cell, where R2 is undefined at
+  the first value, showed its cell size, not the one-fewer values its S and limits use. Limits,
+  centres and statistics are unchanged (#143).
+- **`execute()` no longer documents `phased=True` as requiring `by=[]`.** Stratified phasing of X/mR
+  (`by=['factor 1'], phased=True`) has been accepted since 75bcdd1; the docstring never caught up. (#144)
+- **The companion mR of a phased X chart reports `single_point_phases`.** Only the solo mR did. (#144)
+- **X/mR lane order honours an ordered pandas Categorical factor.** A stage column with categories
+  `before < after` already ordered the Xbar/S subgroups that way, but the canonical row order sorted
+  the raw labels, so X/mR lanes, phases and `strata` came out `after, before`. The canonical sort now
+  uses an ordered Categorical's category codes; plain string and numeric factors sort as before. (#144)
+
 ## [0.4.0] - 2026-10-14
 
 This release aligns the library with Bishop's VAS documentation manual dated 10-12-2026 and
@@ -1114,7 +1181,8 @@ and may change between minor versions until 1.0.
 - `natsort >= 8.0`
 - `plotly >= 5.18, < 7`
 
-[Unreleased]: https://github.com/cnicholas/processbehavior/compare/v0.4.0...HEAD
+[Unreleased]: https://github.com/cnicholas/processbehavior/compare/v0.5.0...HEAD
+[0.5.0]: https://github.com/cnicholas/processbehavior/compare/v0.4.0...v0.5.0
 [0.4.0]: https://github.com/cnicholas/processbehavior/compare/v0.3.3...v0.4.0
 [0.3.3]: https://github.com/cnicholas/processbehavior/compare/v0.3.2...v0.3.3
 [0.3.2]: https://github.com/cnicholas/processbehavior/compare/v0.3.1...v0.3.2

{processbehavior-0.4.0 → processbehavior-0.5.0}/CITATION.cff

@@ -17,7 +17,7 @@ authors:
 repository-code: "https://github.com/cnicholas/processbehavior"
 url: "https://cnicholas.github.io/processbehavior/"
 license: Apache-2.0
-version: 0.2.0
+version: 0.5.0
 keywords:
   - statistical process control
   - process behavior charts

{processbehavior-0.4.0 → processbehavior-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: processbehavior
-Version: 0.4.0
+Version: 0.5.0
 Summary: Python-native Process Behavior & Control Charts (spec-driven SPC with tidy outputs)
 Project-URL: Homepage, https://github.com/cnicholas/processbehavior
 Project-URL: Repository, https://github.com/cnicholas/processbehavior
@@ -108,6 +108,22 @@ pip install "processbehavior[images]"  # kaleido, for static plot images
 
 ## Quickstart
 
+A column of values, charted in the order received, is an X/mR chart in two calls:
+
+```python
+import pandas as pd
+import processbehavior as pb
+
+df = pd.DataFrame({'weight': [50.2, 49.8, 50.5, 50.1, 49.6, 50.9, 50.3, 49.9, 50.4, 50.0, 49.7, 50.6]})
+
+study = pb.formulate(df, response='weight')   # no time column: rows are numbered 1..N as 'Observation'
+result = study.execute(companion=True)        # X chart with its mR companion
+print(result.statistics('X'))                 # {'N': 1, 'center': 50.167, 'lpl': 48.619, 'upl': 51.714}
+result.plot()
+```
+
+When the data has a time order, factors, or both, name them. The design state routes the analysis:
+
 ```python
 import processbehavior as pb
 
@@ -149,6 +165,20 @@ The whole pipeline is one expression when you don't need the intermediate object
 pb.formulate(df, response='y', factors=['factor 1'], time='time').execute().plot()
 ```
 
+A process that changed on purpose gets its own limits for each stage with `phased=True`:
+
+```python
+import processbehavior as pb
+
+# The bundled coffee-shop data: a new machine in week 8, a new POS in week 12, new baristas from week 14
+pbd = pb.load_coffee_shop().bin('week', method='breaks', breaks=[8, 12, 14],
+                                bin_labels=['baseline', 'new machine', 'new POS', 'new baristas'],
+                                label='stage')
+staged = pbd.formulate(response='wait_sec', factors=['stage'], time='date').execute(chart='Xbar', phased=True, companion=True)
+staged.phase_statistics('Xbar')   # one row per stage: center, S-bar, sigma-hat, limits
+staged.plot(chart='Xbar', title='Wait time: limits per stage')
+```
+
 Use `pb.ProcessBehavior(df)` directly when you want the fluent derived-variable verbs
 (`.transform(...)`, `.bin(...)`), which attach before formulating. With that object in hand,
 `pbd.cols.<column_name>` provides IDE auto-completion for column references.
@@ -251,6 +281,7 @@ The full report renders to `validation/e2e_bishop_report.html`.
 - **Variance decomposition**: R1-R6 residuals for factorial designs
 - **Effects analysis**: Main effects, time effects, and interaction effects
 - **Stratified charts**: Automatic per-stratum limits for grouped individual data
+- **Staged charts**: `phased=True` gives each stage its own center and limits on X/mR and Xbar/S; `phase_statistics()` returns the numbers behind the steps
 - **Signal detection**: all eight Western Electric rules on X/mR; Rule 1 (3-sigma) on Xbar/S, where the run- and zone-based rules need a time order that subgroup comparisons don't have
 - **Beyond the charts**: capability indices (Cp/Cpk/Pp/Ppk), Taguchi loss decomposition, and maximum-information analysis — validated in the same Bishop-reference CI gate
 - **IDE support**: Column auto-completion via `ProcessBehavior(df).cols`

{processbehavior-0.4.0 → processbehavior-0.5.0}/README.md

@@ -25,6 +25,22 @@ pip install "processbehavior[images]"  # kaleido, for static plot images
 
 ## Quickstart
 
+A column of values, charted in the order received, is an X/mR chart in two calls:
+
+```python
+import pandas as pd
+import processbehavior as pb
+
+df = pd.DataFrame({'weight': [50.2, 49.8, 50.5, 50.1, 49.6, 50.9, 50.3, 49.9, 50.4, 50.0, 49.7, 50.6]})
+
+study = pb.formulate(df, response='weight')   # no time column: rows are numbered 1..N as 'Observation'
+result = study.execute(companion=True)        # X chart with its mR companion
+print(result.statistics('X'))                 # {'N': 1, 'center': 50.167, 'lpl': 48.619, 'upl': 51.714}
+result.plot()
+```
+
+When the data has a time order, factors, or both, name them. The design state routes the analysis:
+
 ```python
 import processbehavior as pb
 
@@ -66,6 +82,20 @@ The whole pipeline is one expression when you don't need the intermediate object
 pb.formulate(df, response='y', factors=['factor 1'], time='time').execute().plot()
 ```
 
+A process that changed on purpose gets its own limits for each stage with `phased=True`:
+
+```python
+import processbehavior as pb
+
+# The bundled coffee-shop data: a new machine in week 8, a new POS in week 12, new baristas from week 14
+pbd = pb.load_coffee_shop().bin('week', method='breaks', breaks=[8, 12, 14],
+                                bin_labels=['baseline', 'new machine', 'new POS', 'new baristas'],
+                                label='stage')
+staged = pbd.formulate(response='wait_sec', factors=['stage'], time='date').execute(chart='Xbar', phased=True, companion=True)
+staged.phase_statistics('Xbar')   # one row per stage: center, S-bar, sigma-hat, limits
+staged.plot(chart='Xbar', title='Wait time: limits per stage')
+```
+
 Use `pb.ProcessBehavior(df)` directly when you want the fluent derived-variable verbs
 (`.transform(...)`, `.bin(...)`), which attach before formulating. With that object in hand,
 `pbd.cols.<column_name>` provides IDE auto-completion for column references.
@@ -168,6 +198,7 @@ The full report renders to `validation/e2e_bishop_report.html`.
 - **Variance decomposition**: R1-R6 residuals for factorial designs
 - **Effects analysis**: Main effects, time effects, and interaction effects
 - **Stratified charts**: Automatic per-stratum limits for grouped individual data
+- **Staged charts**: `phased=True` gives each stage its own center and limits on X/mR and Xbar/S; `phase_statistics()` returns the numbers behind the steps
 - **Signal detection**: all eight Western Electric rules on X/mR; Rule 1 (3-sigma) on Xbar/S, where the run- and zone-based rules need a time order that subgroup comparisons don't have
 - **Beyond the charts**: capability indices (Cp/Cpk/Pp/Ppk), Taguchi loss decomposition, and maximum-information analysis — validated in the same Bishop-reference CI gate
 - **IDE support**: Column auto-completion via `ProcessBehavior(df).cols`

{processbehavior-0.4.0 → processbehavior-0.5.0}/processbehavior/__init__.py

@@ -47,7 +47,7 @@ its ``.sds`` field. Internally some modules still use the legacy "SDS"
 prefix (e.g. ``sds_detector.py``); the model itself is three-state.
 """
 
-__version__ = '0.4.0'
+__version__ = '0.5.0'
 
 # Result object
 from processbehavior.analysis_result import AnalysisResult