kitagawa_decompose
Decompose a rate difference between two groups into composition and rate components. Identifies how much of the gap comes from group composition versus category-specific rates.
Instructions
Kitagawa (1955) two-factor rate decomposition. Validation: certified parity evidence.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| by | Yes | Category variable(s) defining cells. | |
| rate | Yes | Column holding the category-specific rate (or 0/1 outcome at the individual level). | |
| group | Yes | Binary group indicator. | |
| detail | No | Payload depth: 'minimal' (~150 tokens) for sub-step calls where only the point estimate is needed; 'standard' (~1K tokens) for diagnostics + coefficient table; 'agent' (~2K tokens, default) adds violations / next_steps / suggested_functions so the LLM can plan its next call without another round-trip. | agent |
| weights | No | Cell population weights. If None, each row treated as individual-level data (weight = 1). | |
| as_handle | No | If true, cache the fitted result on the server and return result_id + result_uri alongside the JSON payload so a subsequent tools/call can chain without re-running. | |
| data_path | Yes | Absolute path or URL to a data file. Supported: .csv / .tsv / .txt (delimited), .parquet / .pq, .feather / .arrow, .xlsx / .xls, .dta (Stata), .json / .jsonl. Schemes: file://, s3://, gs://, https://. | |
| normalize | No | - 'a': rate effect evaluated at A's composition - 'b': rate effect evaluated at B's composition - 'symmetric': average (default) | symmetric |
| result_id | No | Optional handle to a previously-fitted result (returned by an earlier call when as_handle=true). Tools that operate on a fitted object accept this in place of re-supplying data_path + columns. | |
| data_columns | No | Optional column projection. Parquet/Feather/Stata loaders honour this for fast partial reads. | |
| data_sample_n | No | Optional uniform random subsample size (seed=0, deterministic) — useful on huge panels. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||