Skip to content

Commit 405de88

Browse files
igerberigerber
authored
Merge pull request #206 from igerber/documentation-review
Comprehensive documentation review and update
2 parents 2acf245 + 1ac1788 commit 405de88

81 files changed

Lines changed: 3202 additions & 276 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎TODO.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ Deferred items from PR reviews that were not addressed before merge.
6262
| Tutorial notebooks not executed in CI | `docs/tutorials/*.ipynb` | #159 | Low |
6363
| R comparison tests spawn separate `Rscript` per test (slow CI) | `tests/test_methodology_twfe.py:294` | #139 | Low |
6464
| CS R helpers hard-code `xformla = ~ 1`; no covariate-adjusted R benchmark for IRLS path | `tests/test_methodology_callaway.py` | #202 | Low |
65+
| 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 |
6566

6667
---
6768

‎diff_diff/datasets.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ def load_castle_doctrine(force_download: bool = False) -> pd.DataFrame:
266266
... outcome="homicide_rate",
267267
... unit="state",
268268
... time="year",
269-
... cohort="first_treat"
269+
... first_treat="first_treat"
270270
... )
271271
"""
272272
url = "https://raw.githubusercontent.com/causaldata/causal_datasets/main/castle/castle.csv"
@@ -412,7 +412,7 @@ def load_divorce_laws(force_download: bool = False) -> pd.DataFrame:
412412
... outcome="divorce_rate",
413413
... unit="state",
414414
... time="year",
415-
... cohort="first_treat"
415+
... first_treat="first_treat"
416416
... )
417417
"""
418418
# Try to load from causaldata repository
@@ -571,7 +571,7 @@ def load_mpdta(force_download: bool = False) -> pd.DataFrame:
571571
... outcome="lemp",
572572
... unit="countyreal",
573573
... time="year",
574-
... cohort="first_treat"
574+
... first_treat="first_treat"
575575
... )
576576
"""
577577
# mpdta is available from the did package documentation

‎docs/api/_autosummary/diff_diff.BaconDecomposition.rst‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
diff\_diff.BaconDecomposition
2+
=============================
3+
4+
.. currentmodule:: diff_diff
5+
6+
.. autoclass:: BaconDecomposition
7+
8+
9+
.. automethod:: __init__
10+
11+
12+
.. rubric:: Methods
13+
14+
.. autosummary::
15+
16+
~BaconDecomposition.__init__
17+
~BaconDecomposition.fit
18+
~BaconDecomposition.get_params
19+
~BaconDecomposition.print_summary
20+
~BaconDecomposition.set_params
21+
~BaconDecomposition.summary
22+
23+
24+
25+
26+
27+

‎docs/api/_autosummary/diff_diff.BaconDecompositionResults.rst‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
diff\_diff.BaconDecompositionResults
2+
====================================
3+
4+
.. currentmodule:: diff_diff
5+
6+
.. autoclass:: BaconDecompositionResults
7+
8+
9+
.. automethod:: __init__
10+
11+
12+
.. rubric:: Methods
13+
14+
.. autosummary::
15+
16+
~BaconDecompositionResults.__init__
17+
~BaconDecompositionResults.effect_by_type
18+
~BaconDecompositionResults.print_summary
19+
~BaconDecompositionResults.summary
20+
~BaconDecompositionResults.to_dataframe
21+
~BaconDecompositionResults.weight_by_type
22+
23+
24+
25+
26+
27+
.. rubric:: Attributes
28+
29+
.. autosummary::
30+
31+
~BaconDecompositionResults.decomposition_error
32+
~BaconDecompositionResults.n_obs
33+
~BaconDecompositionResults.twfe_estimate
34+
~BaconDecompositionResults.comparisons
35+
~BaconDecompositionResults.total_weight_treated_vs_never
36+
~BaconDecompositionResults.total_weight_earlier_vs_later
37+
~BaconDecompositionResults.total_weight_later_vs_earlier
38+
~BaconDecompositionResults.weighted_avg_treated_vs_never
39+
~BaconDecompositionResults.weighted_avg_earlier_vs_later
40+
~BaconDecompositionResults.weighted_avg_later_vs_earlier
41+
~BaconDecompositionResults.n_timing_groups
42+
~BaconDecompositionResults.n_never_treated
43+
~BaconDecompositionResults.timing_groups
44+
45+

‎docs/api/_autosummary/diff_diff.CSBootstrapResults.rst‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
diff\_diff.CSBootstrapResults
2+
=============================
3+
4+
.. currentmodule:: diff_diff
5+
6+
.. autoclass:: CSBootstrapResults
7+
8+
9+
.. automethod:: __init__
10+
11+
12+
.. rubric:: Methods
13+
14+
.. autosummary::
15+
16+
~CSBootstrapResults.__init__
17+
18+
19+
20+
21+
22+
.. rubric:: Attributes
23+
24+
.. autosummary::
25+
26+
~CSBootstrapResults.bootstrap_distribution
27+
~CSBootstrapResults.cband_crit_value
28+
~CSBootstrapResults.event_study_cis
29+
~CSBootstrapResults.event_study_p_values
30+
~CSBootstrapResults.event_study_ses
31+
~CSBootstrapResults.group_effect_cis
32+
~CSBootstrapResults.group_effect_p_values
33+
~CSBootstrapResults.group_effect_ses
34+
~CSBootstrapResults.n_bootstrap
35+
~CSBootstrapResults.weight_type
36+
~CSBootstrapResults.alpha
37+
~CSBootstrapResults.overall_att_se
38+
~CSBootstrapResults.overall_att_ci
39+
~CSBootstrapResults.overall_att_p_value
40+
~CSBootstrapResults.group_time_ses
41+
~CSBootstrapResults.group_time_cis
42+
~CSBootstrapResults.group_time_p_values
43+
44+

‎docs/api/_autosummary/diff_diff.CallawaySantAnna.rst‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,15 @@
2424

2525

2626

27+
.. rubric:: Attributes
28+
29+
.. autosummary::
30+
31+
~CallawaySantAnna.n_bootstrap
32+
~CallawaySantAnna.bootstrap_weight_type
33+
~CallawaySantAnna.alpha
34+
~CallawaySantAnna.seed
35+
~CallawaySantAnna.anticipation
36+
~CallawaySantAnna.base_period
37+
2738

‎docs/api/_autosummary/diff_diff.CallawaySantAnnaResults.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,15 @@
2727
.. autosummary::
2828

2929
~CallawaySantAnnaResults.alpha
30+
~CallawaySantAnnaResults.base_period
31+
~CallawaySantAnnaResults.bootstrap_results
32+
~CallawaySantAnnaResults.cband_crit_value
3033
~CallawaySantAnnaResults.control_group
3134
~CallawaySantAnnaResults.event_study_effects
3235
~CallawaySantAnnaResults.group_effects
3336
~CallawaySantAnnaResults.influence_functions
3437
~CallawaySantAnnaResults.is_significant
38+
~CallawaySantAnnaResults.pscore_trim
3539
~CallawaySantAnnaResults.significance_stars
3640
~CallawaySantAnnaResults.group_time_effects
3741
~CallawaySantAnnaResults.overall_att

‎docs/api/_autosummary/diff_diff.Comparison2x2.rst‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
diff\_diff.Comparison2x2
2+
========================
3+
4+
.. currentmodule:: diff_diff
5+
6+
.. autoclass:: Comparison2x2
7+
8+
9+
.. automethod:: __init__
10+
11+
12+
.. rubric:: Methods
13+
14+
.. autosummary::
15+
16+
~Comparison2x2.__init__
17+
18+
19+
20+
21+
22+
.. rubric:: Attributes
23+
24+
.. autosummary::
25+
26+
~Comparison2x2.treated_group
27+
~Comparison2x2.control_group
28+
~Comparison2x2.comparison_type
29+
~Comparison2x2.estimate
30+
~Comparison2x2.weight
31+
~Comparison2x2.n_treated
32+
~Comparison2x2.n_control
33+
~Comparison2x2.time_window
34+
35+

‎docs/api/_autosummary/diff_diff.ContinuousDiD.rst‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
diff\_diff.ContinuousDiD
2+
========================
3+
4+
.. currentmodule:: diff_diff
5+
6+
.. autoclass:: ContinuousDiD
7+
8+
9+
.. automethod:: __init__
10+
11+
12+
.. rubric:: Methods
13+
14+
.. autosummary::
15+
16+
~ContinuousDiD.__init__
17+
~ContinuousDiD.fit
18+
~ContinuousDiD.get_params
19+
~ContinuousDiD.set_params
20+
21+
22+
23+
24+
25+

‎docs/api/_autosummary/diff_diff.ContinuousDiDResults.rst‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
diff\_diff.ContinuousDiDResults
2+
===============================
3+
4+
.. currentmodule:: diff_diff
5+
6+
.. autoclass:: ContinuousDiDResults
7+
8+
9+
.. automethod:: __init__
10+
11+
12+
.. rubric:: Methods
13+
14+
.. autosummary::
15+
16+
~ContinuousDiDResults.__init__
17+
~ContinuousDiDResults.print_summary
18+
~ContinuousDiDResults.summary
19+
~ContinuousDiDResults.to_dataframe
20+
21+
22+
23+
24+
25+
.. rubric:: Attributes
26+
27+
.. autosummary::
28+
29+
~ContinuousDiDResults.alpha
30+
~ContinuousDiDResults.anticipation
31+
~ContinuousDiDResults.base_period
32+
~ContinuousDiDResults.bootstrap_weights
33+
~ContinuousDiDResults.control_group
34+
~ContinuousDiDResults.degree
35+
~ContinuousDiDResults.event_study_effects
36+
~ContinuousDiDResults.is_significant
37+
~ContinuousDiDResults.n_bootstrap
38+
~ContinuousDiDResults.num_knots
39+
~ContinuousDiDResults.rank_deficient_action
40+
~ContinuousDiDResults.seed
41+
~ContinuousDiDResults.significance_stars
42+
~ContinuousDiDResults.dose_response_att
43+
~ContinuousDiDResults.dose_response_acrt
44+
~ContinuousDiDResults.overall_att
45+
~ContinuousDiDResults.overall_att_se
46+
~ContinuousDiDResults.overall_att_t_stat
47+
~ContinuousDiDResults.overall_att_p_value
48+
~ContinuousDiDResults.overall_att_conf_int
49+
~ContinuousDiDResults.overall_acrt
50+
~ContinuousDiDResults.overall_acrt_se
51+
~ContinuousDiDResults.overall_acrt_t_stat
52+
~ContinuousDiDResults.overall_acrt_p_value
53+
~ContinuousDiDResults.overall_acrt_conf_int
54+
~ContinuousDiDResults.group_time_effects
55+
~ContinuousDiDResults.dose_grid
56+
~ContinuousDiDResults.groups
57+
~ContinuousDiDResults.time_periods
58+
~ContinuousDiDResults.n_obs
59+
~ContinuousDiDResults.n_treated_units
60+
~ContinuousDiDResults.n_control_units
61+
62+

0 commit comments

Comments
 (0)