decompose
Decompose outcome gaps between groups using validated methods like Oaxaca-Blinder, RIF, or Machado-Mata. Receive diagnostics and actionable next steps to address violations and plan analysis.
Instructions
Unified entry point for all decomposition methods. Validation: certified parity evidence. Assumptions: Overlapping support of covariates across groups (reweighting / RIF methods are invalid outside overlap); Linearity assumption holds for Oaxaca-Blinder-type decompositions; non-linear methods (FFL/DFL/Machado-Mata) relax this; Conditional independence of group membership for causal interpretation (otherwise: descriptive decomposition only). Pre-conditions: Data contains a binary or categorical group indicator with both groups represented; Outcome and covariates are numeric (or properly encoded) and finite; Sample sizes per group are large enough to estimate group-specific moments (rule of thumb: each group >= 100). Failure modes: Trimming warning at common-support boundaries -> Inspect propensity-score support; restrict the analysis sample or use bounds; RIF coefficients explode at distribution tails -> Use higher-bandwidth kernel density, restrict quantile range, or switch to FFL. Alternatives: sp.dfl_decompose, sp.ffl_decompose, sp.oaxaca, sp.rif_decomposition. Typical minimum N: 200.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| 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 |
| method | Yes | One of the methods listed in ``available_methods()``. Aliases are supported (e.g. 'mm' -> 'machado_mata'). | |
| 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 | No | 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://. | |
| 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 | |||