source_decompose
Decompose total income inequality into source-specific contributions using Lerman-Yitzhaki Gini decomposition, revealing each source's share and correlation with total income.
Instructions
Lerman-Yitzhaki (1985) Gini source decomposition. Validation: certified parity evidence.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| gini | No | ``"corrected"`` uses the ``n/(n-1)`` bias-corrected Gini, the default of :func:`inequality_index`. ``"population"`` uses the plug-in Gini, as Stata's ``descogini`` and Lerman & Yitzhaki's covariance formula do; shares ``S_k``, Gini correlations ``R_k`` and each source's percentage of the total are identical under both, since the factor cancels. | corrected |
| 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 |
| sources | Yes | Income-source columns; total income is their row sum. | |
| weights | No | Observation weights. | |
| 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://. | |
| 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 | |||