overlap_plot
Plot mirrored density of propensity scores by treatment group to assess overlap and support causal analysis decisions.
Instructions
Mirrored density plot of propensity scores by treatment group.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"covariates": "<covariates>",
"data_path": "<data_path>",
"treatment": "<treatment>"
},
"name": "overlap_plot"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ax | No | Axes to plot on. If None, a new figure is created. | |
| ps | No | Pre-estimated propensity scores. | |
| title | No | Plot title. | Propensity Score Overlap |
| 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 | No | PS estimation method if *ps* is None. | logit |
| figsize | No | Figure size (width, height). | |
| 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. | |
| treatment | Yes | Binary treatment column. | |
| covariates | Yes | Covariates for PS estimation (ignored if *ps* supplied). | |
| 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 | |||