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
3 changes: 3 additions & 0 deletions docs/api/bacon.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ Main estimator class for the Goodman-Bacon decomposition.
:undoc-members:
:show-inheritance:
:inherited-members:
:no-index:

.. rubric:: Methods

Expand All @@ -55,6 +56,7 @@ Results container for the Bacon decomposition.
:members:
:undoc-members:
:show-inheritance:
:no-index:

.. rubric:: Methods

Expand All @@ -75,6 +77,7 @@ Container for an individual 2x2 DiD comparison within the decomposition.
:members:
:undoc-members:
:show-inheritance:
:no-index:

Convenience Function
--------------------
Expand Down
2 changes: 2 additions & 0 deletions docs/api/business_report.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,10 +98,12 @@ API
---

.. autoclass:: diff_diff.BusinessReport
:no-index:
:members:
:show-inheritance:

.. autoclass:: diff_diff.BusinessContext
:no-index:
:members:
:show-inheritance:

Expand Down
4 changes: 4 additions & 0 deletions docs/api/chaisemartin_dhaultfoeuille.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ Main estimator class for de Chaisemartin-D'Haultfœuille (dCDH) DiD estimation.
The alias :class:`~diff_diff.DCDH` is also available.

.. autoclass:: diff_diff.ChaisemartinDHaultfoeuille
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -128,6 +129,7 @@ ChaisemartinDHaultfoeuilleResults
Results container for dCDH estimation.

.. autoclass:: diff_diff.ChaisemartinDHaultfoeuilleResults
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -146,6 +148,7 @@ DCDHBootstrapResults
Multiplier-bootstrap inference results, populated when ``n_bootstrap > 0``.

.. autoclass:: diff_diff.DCDHBootstrapResults
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -168,6 +171,7 @@ treatment effects that could flip the sign of the plain TWFE coefficient.
.. autofunction:: diff_diff.twowayfeweights

.. autoclass:: diff_diff.chaisemartin_dhaultfoeuille.TWFEWeightsResult
:no-index:
:members:

Example Usage
Expand Down
3 changes: 3 additions & 0 deletions docs/api/continuous_did.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ ContinuousDiD
Main estimator class for Continuous Difference-in-Differences.

.. autoclass:: diff_diff.ContinuousDiD
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -65,6 +66,7 @@ ContinuousDiDResults
Results container for Continuous DiD estimation.

.. autoclass:: diff_diff.continuous_did_results.ContinuousDiDResults
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -83,6 +85,7 @@ DoseResponseCurve
Dose-response curve container for ATT(d) or ACRT(d).

.. autoclass:: diff_diff.continuous_did_results.DoseResponseCurve
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand Down
2 changes: 2 additions & 0 deletions docs/api/diagnostic_report.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,10 +73,12 @@ API
---

.. autoclass:: diff_diff.DiagnosticReport
:no-index:
:members:
:show-inheritance:

.. autoclass:: diff_diff.DiagnosticReportResults
:no-index:
:members:
:show-inheritance:

Expand Down
1 change: 1 addition & 0 deletions docs/api/diagnostics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ PlaceboTestResults
Container for placebo test results.

.. autoclass:: diff_diff.PlaceboTestResults
:no-index:
:members:
:undoc-members:
:show-inheritance:
3 changes: 3 additions & 0 deletions docs/api/efficient_did.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ EfficientDiD
Main estimator class for Efficient Difference-in-Differences.

.. autoclass:: diff_diff.EfficientDiD
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -68,6 +69,7 @@ EfficientDiDResults
Results container for Efficient DiD estimation.

.. autoclass:: diff_diff.efficient_did_results.EfficientDiDResults
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -86,6 +88,7 @@ EDiDBootstrapResults
Bootstrap inference results for Efficient DiD.

.. autoclass:: diff_diff.efficient_did_bootstrap.EDiDBootstrapResults
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand Down
4 changes: 4 additions & 0 deletions docs/api/estimators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ DifferenceInDifferences (alias: ``DiD``)
Basic 2x2 DiD estimator.

.. autoclass:: diff_diff.DifferenceInDifferences
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -50,6 +51,7 @@ MultiPeriodDiD (alias: ``EventStudy``)
Event study estimator with period-specific treatment effects.

.. autoclass:: diff_diff.MultiPeriodDiD
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -63,6 +65,7 @@ Panel DiD with unit and time fixed effects.
.. module:: diff_diff.twfe

.. autoclass:: diff_diff.TwoWayFixedEffects
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -76,6 +79,7 @@ Synthetic control combined with DiD (Arkhangelsky et al. 2021).
.. module:: diff_diff.synthetic_did

.. autoclass:: diff_diff.SyntheticDiD
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand Down
8 changes: 8 additions & 0 deletions docs/api/had.rst
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ HeterogeneousAdoptionDiD
------------------------

.. autoclass:: diff_diff.HeterogeneousAdoptionDiD
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -130,6 +131,7 @@ HeterogeneousAdoptionDiDResults
Single-period results container for ``HeterogeneousAdoptionDiD`` estimation.

.. autoclass:: diff_diff.HeterogeneousAdoptionDiDResults
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -140,6 +142,7 @@ HeterogeneousAdoptionDiDEventStudyResults
Multi-period event-study results container for the Appendix B.2 extension.

.. autoclass:: diff_diff.HeterogeneousAdoptionDiDEventStudyResults
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -162,6 +165,7 @@ unified :class:`~diff_diff.HADPretestReport`.
.. autofunction:: diff_diff.did_had_pretest_workflow

.. autoclass:: diff_diff.HADPretestReport
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -176,16 +180,19 @@ Single-period tests (``aggregate="overall"``)
.. autofunction:: diff_diff.yatchew_hr_test

.. autoclass:: diff_diff.QUGTestResults
:no-index:
:members:
:undoc-members:
:show-inheritance:

.. autoclass:: diff_diff.StuteTestResults
:no-index:
:members:
:undoc-members:
:show-inheritance:

.. autoclass:: diff_diff.YatchewTestResults
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -200,6 +207,7 @@ Joint multi-period tests (``aggregate="event_study"``)
.. autofunction:: diff_diff.joint_homogeneity_test

.. autoclass:: diff_diff.StuteJointResult
:no-index:
:members:
:undoc-members:
:show-inheritance:
6 changes: 6 additions & 0 deletions docs/api/honest_did.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ HonestDiD
Main class for computing honest bounds and confidence intervals.

.. autoclass:: diff_diff.HonestDiD
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand Down Expand Up @@ -65,6 +66,7 @@ HonestDiDResults
Results from HonestDiD estimation.

.. autoclass:: diff_diff.HonestDiDResults
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -75,6 +77,7 @@ SensitivityResults
Results from sensitivity analysis over a grid of M values.

.. autoclass:: diff_diff.SensitivityResults
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -88,6 +91,7 @@ DeltaSD
Smoothness restriction class.

.. autoclass:: diff_diff.DeltaSD
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -98,6 +102,7 @@ DeltaRM
Relative magnitudes restriction class.

.. autoclass:: diff_diff.DeltaRM
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -108,6 +113,7 @@ DeltaSDRM
Combined smoothness and relative magnitudes restriction.

.. autoclass:: diff_diff.DeltaSDRM
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand Down
3 changes: 3 additions & 0 deletions docs/api/imputation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ ImputationDiD
Main estimator class for imputation DiD estimation.

.. autoclass:: diff_diff.ImputationDiD
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -55,6 +56,7 @@ ImputationDiDResults
Results container for imputation DiD estimation.

.. autoclass:: diff_diff.ImputationDiDResults
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -74,6 +76,7 @@ ImputationBootstrapResults
Bootstrap inference results.

.. autoclass:: diff_diff.ImputationBootstrapResults
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand Down
3 changes: 3 additions & 0 deletions docs/api/local_linear.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ Kernel-weighted OLS estimator of the conditional mean
.. autofunction:: diff_diff.local_linear_fit

.. autoclass:: diff_diff.LocalLinearFit
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -76,6 +77,7 @@ selector against the R ``nprobust`` reference.
.. autofunction:: diff_diff.mse_optimal_bandwidth

.. autoclass:: diff_diff.BandwidthResult
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -91,6 +93,7 @@ and 95% confidence interval.
.. autofunction:: diff_diff.bias_corrected_local_linear

.. autoclass:: diff_diff.BiasCorrectedFit
:no-index:
:members:
:undoc-members:
:show-inheritance:
5 changes: 5 additions & 0 deletions docs/api/power.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ PowerAnalysis
Main class for analytical power calculations.

.. autoclass:: diff_diff.PowerAnalysis
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand Down Expand Up @@ -63,6 +64,7 @@ PowerResults
Results from power analysis.

.. autoclass:: diff_diff.PowerResults
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -73,6 +75,7 @@ SimulationPowerResults
Results from simulation-based power analysis.

.. autoclass:: diff_diff.SimulationPowerResults
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -83,6 +86,7 @@ SimulationMDEResults
Results from simulation-based MDE search.

.. autoclass:: diff_diff.SimulationMDEResults
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -93,6 +97,7 @@ SimulationSampleSizeResults
Results from simulation-based sample size search.

.. autoclass:: diff_diff.SimulationSampleSizeResults
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand Down
3 changes: 3 additions & 0 deletions docs/api/pretrends.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ PreTrendsPower
Main class for pre-trends power analysis.

.. autoclass:: diff_diff.PreTrendsPower
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand Down Expand Up @@ -66,6 +67,7 @@ PreTrendsPowerResults
Results from pre-trends power analysis.

.. autoclass:: diff_diff.PreTrendsPowerResults
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -76,6 +78,7 @@ PreTrendsPowerCurve
Power curve across violation magnitudes.

.. autoclass:: diff_diff.PreTrendsPowerCurve
:no-index:
:members:
:undoc-members:
:show-inheritance:
Expand Down
Loading
Loading