Skip to content

Commit 308ee80

Browse files
committed
Document Event Study support in effect_summary
Added Event Study to the experiment support table in reporting_statistics.md and updated AGENTS.md to instruct updating the table when adding new experiment types.
1 parent 1d66f25 commit 308ee80

File tree

2 files changed

+2
-0
lines changed

2 files changed

+2
-0
lines changed

AGENTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
- `docs/source/index.md` (documentation website homepage)
2525

2626
When adding major new features to the Features table or making other content changes, update **both files**. The Features table lists all quasi-experimental methods supported by CausalPy.
27+
- **Reporting statistics**: When adding new experiment types, update the "Experiment Support" table in `docs/source/knowledgebase/reporting_statistics.md` to document `effect_summary()` support status for the new experiment.
2728
- **Structure**: Notebooks (how-to examples) go in `docs/source/notebooks/`, knowledgebase (educational content) goes in `docs/source/knowledgebase/`
2829
- **Notebook naming**: Use pattern `{method}_{model}.ipynb` (e.g., `did_pymc.ipynb`, `rd_skl.ipynb`), organized by causal method
2930
- **Notebook index**: New notebooks must be added to `docs/source/notebooks/index.md` under the appropriate `toctree` section for them to appear in the rendered documentation

docs/source/knowledgebase/reporting_statistics.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ The `effect_summary()` method is available for the following experiment types:
2626
| Regression Kink | ✅ Full support | ❌ Not implemented |
2727
| Interrupted Time Series | ✅ Full support | ✅ Full support |
2828
| Synthetic Control | ✅ Full support | ✅ Full support |
29+
| Event Study | ✅ Full support | ✅ Full support |
2930
| PrePostNEGD | ❌ Use `.summary()` instead | ❌ Use `.summary()` instead |
3031
| Instrumental Variable | ❌ Not available | ❌ Not available |
3132
| Inverse Propensity Weighting | ❌ Not available | ❌ Not available |

0 commit comments

Comments
 (0)