synthplot
Plot any Synthetic Control variant—trajectory, gap, placebo, weights, conformal intervals—to inspect causal effects and diagnose fit.
Instructions
Unified plot function for all Synthetic Control variants.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ax | No | Pre-existing axes for single-panel plots. | |
| type | No | Plot type: * ``'trajectory'`` -- treated vs synthetic over time. * ``'gap'`` -- effect (gap) over time. * ``'both'`` -- two-panel: trajectory + gap. * ``'weights'`` -- donor weight bar chart. * ``'placebo'`` -- placebo ATT distribution. * ``'placebo_gap'`` -- placebo gap spaghetti plot (Abadie et al. 2010). * ``'rmspe'`` -- post/pre RMSPE ratio histogram (Abadie et al. 2010). * ``'conformal'`` -- period-level effects + conformal CIs. * ``'staggered'`` -- cohort-level ATT comparison. * ``'factors'`` -- latent factor loadings (gsynth only). * ``'compare'`` -- overlay multiple results. | trajectory |
| title | No | Override the auto-generated title. | |
| top_n | No | Number of donors to show in weight plots. | |
| 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 |
| labels | No | Labels for ``type='compare'``. | |
| result | Yes | Output of any ``synth()`` variant. Pass a list for ``type='compare'``. | |
| figsize | No | Figure size. Auto-selected if None. | |
| 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 | |||