diff-diff 2.1.6__tar.gz → 2.1.8__tar.gz

{diff_diff-2.1.6 → diff_diff-2.1.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: diff-diff
-Version: 2.1.6
+Version: 2.1.8
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Science/Research
 Classifier: Operating System :: OS Independent
@@ -1173,13 +1173,15 @@ trop_est = TROP(
     lambda_nn_grid=[0.0, 0.1, 1.0],          # Nuclear norm grid
     n_bootstrap=200
 )
+# Note: TROP infers treatment periods from the treatment indicator column.
+# The 'treated' column must be an absorbing state (D=1 for all periods
+# during and after treatment starts for each unit).
 results = trop_est.fit(
     panel_data,
     outcome='gdp_growth',
     treatment='treated',
     unit='state',
-    time='year',
-    post_periods=[2015, 2016, 2017, 2018]
+    time='year'
 )
 
 # View results
@@ -1267,9 +1269,11 @@ sdid_results = sdid.fit(data, outcome='y', treatment='treated',
                         unit='unit', time='time', post_periods=[5,6,7])
 
 # TROP (accounts for factors)
+# Note: TROP infers treatment periods from the treatment indicator column
+# (D=1 for treated observations, D=0 for control)
 trop_est = TROP()  # Uses default grids with LOOCV selection
 trop_results = trop_est.fit(data, outcome='y', treatment='treated',
-                            unit='unit', time='time', post_periods=[5,6,7])
+                            unit='unit', time='time')
 
 print(f"SDID estimate: {sdid_results.att:.3f}")
 print(f"TROP estimate: {trop_results.att:.3f}")
@@ -1314,13 +1318,13 @@ TROP(
 
 ```python
 # One-liner estimation with default tuning grids
+# Note: TROP infers treatment periods from the treatment indicator
 results = trop(
     data,
     outcome='y',
     treatment='treated',
     unit='unit',
     time='time',
-    post_periods=[5, 6, 7],
     n_bootstrap=200
 )
 ```
@@ -1912,10 +1916,11 @@ TROP(
 |-----------|------|-------------|
 | `data` | DataFrame | Panel data |
 | `outcome` | str | Outcome variable column name |
-| `treatment` | str | Treatment indicator column (0/1) |
+| `treatment` | str | Treatment indicator column (0/1 absorbing state) |
 | `unit` | str | Unit identifier column |
 | `time` | str | Time period column |
-| `post_periods` | list | List of post-treatment period values |
+
+Note: TROP infers treatment periods from the treatment indicator column. The treatment column should be an absorbing state indicator where D=1 for all periods during and after treatment starts.
 
 ### TROPResults
 
@@ -1941,8 +1946,8 @@ TROP(
 | `factor_matrix` | Low-rank factor matrix L (n_periods x n_units) |
 | `effective_rank` | Effective rank of factor matrix |
 | `loocv_score` | LOOCV score for selected parameters |
-| `pre_periods` | List of pre-treatment periods |
-| `post_periods` | List of post-treatment periods |
+| `n_pre_periods` | Number of pre-treatment periods |
+| `n_post_periods` | Number of post-treatment periods |
 | `variance_method` | Variance estimation method |
 | `bootstrap_distribution` | Bootstrap distribution (if bootstrap) |
 

{diff_diff-2.1.6 → diff_diff-2.1.8}/README.md

@@ -1138,13 +1138,15 @@ trop_est = TROP(
     lambda_nn_grid=[0.0, 0.1, 1.0],          # Nuclear norm grid
     n_bootstrap=200
 )
+# Note: TROP infers treatment periods from the treatment indicator column.
+# The 'treated' column must be an absorbing state (D=1 for all periods
+# during and after treatment starts for each unit).
 results = trop_est.fit(
     panel_data,
     outcome='gdp_growth',
     treatment='treated',
     unit='state',
-    time='year',
-    post_periods=[2015, 2016, 2017, 2018]
+    time='year'
 )
 
 # View results
@@ -1232,9 +1234,11 @@ sdid_results = sdid.fit(data, outcome='y', treatment='treated',
                         unit='unit', time='time', post_periods=[5,6,7])
 
 # TROP (accounts for factors)
+# Note: TROP infers treatment periods from the treatment indicator column
+# (D=1 for treated observations, D=0 for control)
 trop_est = TROP()  # Uses default grids with LOOCV selection
 trop_results = trop_est.fit(data, outcome='y', treatment='treated',
-                            unit='unit', time='time', post_periods=[5,6,7])
+                            unit='unit', time='time')
 
 print(f"SDID estimate: {sdid_results.att:.3f}")
 print(f"TROP estimate: {trop_results.att:.3f}")
@@ -1279,13 +1283,13 @@ TROP(
 
 ```python
 # One-liner estimation with default tuning grids
+# Note: TROP infers treatment periods from the treatment indicator
 results = trop(
     data,
     outcome='y',
     treatment='treated',
     unit='unit',
     time='time',
-    post_periods=[5, 6, 7],
     n_bootstrap=200
 )
 ```
@@ -1877,10 +1881,11 @@ TROP(
 |-----------|------|-------------|
 | `data` | DataFrame | Panel data |
 | `outcome` | str | Outcome variable column name |
-| `treatment` | str | Treatment indicator column (0/1) |
+| `treatment` | str | Treatment indicator column (0/1 absorbing state) |
 | `unit` | str | Unit identifier column |
 | `time` | str | Time period column |
-| `post_periods` | list | List of post-treatment period values |
+
+Note: TROP infers treatment periods from the treatment indicator column. The treatment column should be an absorbing state indicator where D=1 for all periods during and after treatment starts.
 
 ### TROPResults
 
@@ -1906,8 +1911,8 @@ TROP(
 | `factor_matrix` | Low-rank factor matrix L (n_periods x n_units) |
 | `effective_rank` | Effective rank of factor matrix |
 | `loocv_score` | LOOCV score for selected parameters |
-| `pre_periods` | List of pre-treatment periods |
-| `post_periods` | List of post-treatment periods |
+| `n_pre_periods` | Number of pre-treatment periods |
+| `n_post_periods` | Number of post-treatment periods |
 | `variance_method` | Variance estimation method |
 | `bootstrap_distribution` | Bootstrap distribution (if bootstrap) |
 

{diff_diff-2.1.6 → diff_diff-2.1.8}/diff_diff/__init__.py

@@ -136,7 +136,7 @@ from diff_diff.datasets import (
     load_mpdta,
 )
 
-__version__ = "2.1.6"
+__version__ = "2.1.8"
 __all__ = [
     # Estimators
     "DifferenceInDifferences",