Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ Deferred items from PR reviews that were not addressed before merge.
| Tutorial notebooks not executed in CI | `docs/tutorials/*.ipynb` | #159 | Low |
| R comparison tests spawn separate `Rscript` per test (slow CI) | `tests/test_methodology_twfe.py:294` | #139 | Low |
| CS R helpers hard-code `xformla = ~ 1`; no covariate-adjusted R benchmark for IRLS path | `tests/test_methodology_callaway.py` | #202 | Low |
| Context-dependent doc snippets pass via blanket NameError; no standalone validation | `tests/test_doc_snippets.py`, `docs/api/visualization.rst`, `docs/python_comparison.rst`, `docs/r_comparison.rst` | #206 | Low |

---

Expand Down
6 changes: 3 additions & 3 deletions diff_diff/datasets.py
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ def load_castle_doctrine(force_download: bool = False) -> pd.DataFrame:
... outcome="homicide_rate",
... unit="state",
... time="year",
... cohort="first_treat"
... first_treat="first_treat"
... )
"""
url = "https://raw.githubusercontent.com/causaldata/causal_datasets/main/castle/castle.csv"
Expand Down Expand Up @@ -412,7 +412,7 @@ def load_divorce_laws(force_download: bool = False) -> pd.DataFrame:
... outcome="divorce_rate",
... unit="state",
... time="year",
... cohort="first_treat"
... first_treat="first_treat"
... )
"""
# Try to load from causaldata repository
Expand Down Expand Up @@ -571,7 +571,7 @@ def load_mpdta(force_download: bool = False) -> pd.DataFrame:
... outcome="lemp",
... unit="countyreal",
... time="year",
... cohort="first_treat"
... first_treat="first_treat"
... )
"""
# mpdta is available from the did package documentation
Expand Down
27 changes: 27 additions & 0 deletions docs/api/_autosummary/diff_diff.BaconDecomposition.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
diff\_diff.BaconDecomposition
=============================

.. currentmodule:: diff_diff

.. autoclass:: BaconDecomposition


.. automethod:: __init__


.. rubric:: Methods

.. autosummary::

~BaconDecomposition.__init__
~BaconDecomposition.fit
~BaconDecomposition.get_params
~BaconDecomposition.print_summary
~BaconDecomposition.set_params
~BaconDecomposition.summary






45 changes: 45 additions & 0 deletions docs/api/_autosummary/diff_diff.BaconDecompositionResults.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
diff\_diff.BaconDecompositionResults
====================================

.. currentmodule:: diff_diff

.. autoclass:: BaconDecompositionResults


.. automethod:: __init__


.. rubric:: Methods

.. autosummary::

~BaconDecompositionResults.__init__
~BaconDecompositionResults.effect_by_type
~BaconDecompositionResults.print_summary
~BaconDecompositionResults.summary
~BaconDecompositionResults.to_dataframe
~BaconDecompositionResults.weight_by_type





.. rubric:: Attributes

.. autosummary::

~BaconDecompositionResults.decomposition_error
~BaconDecompositionResults.n_obs
~BaconDecompositionResults.twfe_estimate
~BaconDecompositionResults.comparisons
~BaconDecompositionResults.total_weight_treated_vs_never
~BaconDecompositionResults.total_weight_earlier_vs_later
~BaconDecompositionResults.total_weight_later_vs_earlier
~BaconDecompositionResults.weighted_avg_treated_vs_never
~BaconDecompositionResults.weighted_avg_earlier_vs_later
~BaconDecompositionResults.weighted_avg_later_vs_earlier
~BaconDecompositionResults.n_timing_groups
~BaconDecompositionResults.n_never_treated
~BaconDecompositionResults.timing_groups


44 changes: 44 additions & 0 deletions docs/api/_autosummary/diff_diff.CSBootstrapResults.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
diff\_diff.CSBootstrapResults
=============================

.. currentmodule:: diff_diff

.. autoclass:: CSBootstrapResults


.. automethod:: __init__


.. rubric:: Methods

.. autosummary::

~CSBootstrapResults.__init__





.. rubric:: Attributes

.. autosummary::

~CSBootstrapResults.bootstrap_distribution
~CSBootstrapResults.cband_crit_value
~CSBootstrapResults.event_study_cis
~CSBootstrapResults.event_study_p_values
~CSBootstrapResults.event_study_ses
~CSBootstrapResults.group_effect_cis
~CSBootstrapResults.group_effect_p_values
~CSBootstrapResults.group_effect_ses
~CSBootstrapResults.n_bootstrap
~CSBootstrapResults.weight_type
~CSBootstrapResults.alpha
~CSBootstrapResults.overall_att_se
~CSBootstrapResults.overall_att_ci
~CSBootstrapResults.overall_att_p_value
~CSBootstrapResults.group_time_ses
~CSBootstrapResults.group_time_cis
~CSBootstrapResults.group_time_p_values


11 changes: 11 additions & 0 deletions docs/api/_autosummary/diff_diff.CallawaySantAnna.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,15 @@



.. rubric:: Attributes

.. autosummary::

~CallawaySantAnna.n_bootstrap
~CallawaySantAnna.bootstrap_weight_type
~CallawaySantAnna.alpha
~CallawaySantAnna.seed
~CallawaySantAnna.anticipation
~CallawaySantAnna.base_period


4 changes: 4 additions & 0 deletions docs/api/_autosummary/diff_diff.CallawaySantAnnaResults.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,15 @@
.. autosummary::

~CallawaySantAnnaResults.alpha
~CallawaySantAnnaResults.base_period
~CallawaySantAnnaResults.bootstrap_results
~CallawaySantAnnaResults.cband_crit_value
~CallawaySantAnnaResults.control_group
~CallawaySantAnnaResults.event_study_effects
~CallawaySantAnnaResults.group_effects
~CallawaySantAnnaResults.influence_functions
~CallawaySantAnnaResults.is_significant
~CallawaySantAnnaResults.pscore_trim
~CallawaySantAnnaResults.significance_stars
~CallawaySantAnnaResults.group_time_effects
~CallawaySantAnnaResults.overall_att
Expand Down
35 changes: 35 additions & 0 deletions docs/api/_autosummary/diff_diff.Comparison2x2.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
diff\_diff.Comparison2x2
========================

.. currentmodule:: diff_diff

.. autoclass:: Comparison2x2


.. automethod:: __init__


.. rubric:: Methods

.. autosummary::

~Comparison2x2.__init__





.. rubric:: Attributes

.. autosummary::

~Comparison2x2.treated_group
~Comparison2x2.control_group
~Comparison2x2.comparison_type
~Comparison2x2.estimate
~Comparison2x2.weight
~Comparison2x2.n_treated
~Comparison2x2.n_control
~Comparison2x2.time_window


25 changes: 25 additions & 0 deletions docs/api/_autosummary/diff_diff.ContinuousDiD.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
diff\_diff.ContinuousDiD
========================

.. currentmodule:: diff_diff

.. autoclass:: ContinuousDiD


.. automethod:: __init__


.. rubric:: Methods

.. autosummary::

~ContinuousDiD.__init__
~ContinuousDiD.fit
~ContinuousDiD.get_params
~ContinuousDiD.set_params






62 changes: 62 additions & 0 deletions docs/api/_autosummary/diff_diff.ContinuousDiDResults.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
diff\_diff.ContinuousDiDResults
===============================

.. currentmodule:: diff_diff

.. autoclass:: ContinuousDiDResults


.. automethod:: __init__


.. rubric:: Methods

.. autosummary::

~ContinuousDiDResults.__init__
~ContinuousDiDResults.print_summary
~ContinuousDiDResults.summary
~ContinuousDiDResults.to_dataframe





.. rubric:: Attributes

.. autosummary::

~ContinuousDiDResults.alpha
~ContinuousDiDResults.anticipation
~ContinuousDiDResults.base_period
~ContinuousDiDResults.bootstrap_weights
~ContinuousDiDResults.control_group
~ContinuousDiDResults.degree
~ContinuousDiDResults.event_study_effects
~ContinuousDiDResults.is_significant
~ContinuousDiDResults.n_bootstrap
~ContinuousDiDResults.num_knots
~ContinuousDiDResults.rank_deficient_action
~ContinuousDiDResults.seed
~ContinuousDiDResults.significance_stars
~ContinuousDiDResults.dose_response_att
~ContinuousDiDResults.dose_response_acrt
~ContinuousDiDResults.overall_att
~ContinuousDiDResults.overall_att_se
~ContinuousDiDResults.overall_att_t_stat
~ContinuousDiDResults.overall_att_p_value
~ContinuousDiDResults.overall_att_conf_int
~ContinuousDiDResults.overall_acrt
~ContinuousDiDResults.overall_acrt_se
~ContinuousDiDResults.overall_acrt_t_stat
~ContinuousDiDResults.overall_acrt_p_value
~ContinuousDiDResults.overall_acrt_conf_int
~ContinuousDiDResults.group_time_effects
~ContinuousDiDResults.dose_grid
~ContinuousDiDResults.groups
~ContinuousDiDResults.time_periods
~ContinuousDiDResults.n_obs
~ContinuousDiDResults.n_treated_units
~ContinuousDiDResults.n_control_units


36 changes: 36 additions & 0 deletions docs/api/_autosummary/diff_diff.DoseResponseCurve.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
diff\_diff.DoseResponseCurve
============================

.. currentmodule:: diff_diff

.. autoclass:: DoseResponseCurve


.. automethod:: __init__


.. rubric:: Methods

.. autosummary::

~DoseResponseCurve.__init__
~DoseResponseCurve.to_dataframe





.. rubric:: Attributes

.. autosummary::

~DoseResponseCurve.n_bootstrap
~DoseResponseCurve.p_value
~DoseResponseCurve.dose_grid
~DoseResponseCurve.effects
~DoseResponseCurve.se
~DoseResponseCurve.conf_int_lower
~DoseResponseCurve.conf_int_upper
~DoseResponseCurve.target


Loading
Loading