Metadata-Version: 2.4
Name: aipw-analysis
Version: 0.1.2
Summary: Plotting utilities for comparing event-study estimates across estimators.
Author: Corey Gelb-Bicknell
License-Expression: MIT
Project-URL: Homepage, https://github.com/coreygb1/2604_aipw
Project-URL: Repository, https://github.com/coreygb1/2604_aipw
Project-URL: Issues, https://github.com/coreygb1/2604_aipw/issues
Keywords: economics,event-study,plotting,causal-inference,aipw
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: matplotlib>=3.8.0
Requires-Dist: oi-tools>=0.8.0
Dynamic: license-file

# aipw-analysis

`aipw-analysis` provides lightweight plotting utilities for comparing event-study
estimates across estimators, including support for publication-style line plots
with optional confidence bands.

## Install

```bash
pip install aipw-analysis
```

## Quick Start

```python
from aipw_analysis import example_event_study_input, plot_event_study

plot_event_study(
    example_event_study_input(),
    output_path="event_study.png",
    title="ERA pooled ATT event-study estimates by estimator",
    y_limits=(-6000, 1000),
)
```

To add confidence bands and a caption:

```python
from aipw_analysis import example_event_study_input, plot_event_study

plot_event_study(
    example_event_study_input(),
    output_path="event_study_with_ci.png",
    title="ERA pooled ATT event-study estimates by estimator",
    caption="Confidence bands show 95 percent intervals around each series.",
    show_confidence_bands=True,
    y_limits=(-6000, 1000),
)
```

## Public API

- `EventStudySeries`: dataclass for one event-study series
- `plot_event_study()`: save a multi-series event-study figure
- `example_event_study_input()`: generate example plotting inputs

## Development

```bash
source .venv/bin/activate
python -m pip install -e . --no-build-isolation
python -m build --no-isolation
python -m twine check dist/*
```

## Publishing

This repo includes GitHub Actions trusted publishing in
`.github/workflows/publish.yml`. Publishing is triggered by pushing a tag like:

```bash
git tag v0.1.2
git push origin v0.1.2
```
