treatment_rollout_plot
Visualize treatment rollout timing across units. Plot staggered adoption and never-treated cohorts to reveal when each group first receives treatment.
Instructions
Visualise staggered treatment adoption timing.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ax | No | ax parameter. | |
| id | Yes | Unit identifier. | |
| time | Yes | Time period variable. | |
| title | No | title parameter (Optional[str]). | |
| treat | Yes | First-treatment-period column (0 = never treated), or binary treatment 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 |
| figsize | No | figsize parameter (Tuple[float, float]). | |
| sort_by | No | Sort units by: 'treat_time' (earliest first), 'id', or 'random'. | treat_time |
| 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. | |
| never_color | No | Color for never-treated units. | #BDC3C7 |
| 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. | |
| treated_color | No | Color for treated unit-periods. | #E74C3C |
| untreated_color | No | Color for untreated unit-periods. | #ECF0F1 |
| show_cohort_labels | No | Annotate cohort boundaries on the y-axis. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||