event_study_convention
Identify how each difference-in-differences estimator constructs event-study reference periods to resolve disagreements in pre-trend plots. Returns a registry of baseline conventions.
Instructions
Report how each DiD estimator builds its event-study reference periods. Two implementations can agree on every post-treatment coefficient and still plot different pre-trends, because the leads are a separate construction (Roth 2026). Returns the convention registry: what each half of the path is differenced against, whether the two halves are symmetric, and whether the path coincides with a dynamic TWFE event study in a non-staggered design. Failure modes: Estimator name not in the convention registry -> Call sp.event_study_convention() with no argument to list the recorded estimators. Alternatives: sp.compare_event_study_conventions, sp.event_study.
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 |
| 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://. | |
| estimator | No | Registry key such as 'callaway_santanna[base_period=varying]', or a bare estimator name for all of its option-specific rows. None returns the whole registry. | |
| 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 | |||