diffindiff 2.3.2__tar.gz → 2.3.3__tar.gz

{diffindiff-2.3.2 → diffindiff-2.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: diffindiff
-Version: 2.3.2
+Version: 2.3.3
 Summary: diffindiff: Python library for convenient Difference-in-Differences analyses
 Author: Thomas Wieland
 Author-email: geowieland@googlemail.com
@@ -27,7 +27,7 @@ Thomas Wieland [ORCID](https://orcid.org/0000-0001-5168-9846) [EMail](mailto:geo
 
 If you use this software, please cite:
 
-Wieland, T. (2026). diffindiff: A Python library for convenient difference-in-differences analyses (Version 2.3.2) [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.18656820
+Wieland, T. (2026). diffindiff: A Python library for convenient difference-in-differences analyses (Version 2.3.3) [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.18656820
 
 
 ## Installation
@@ -173,7 +173,7 @@ See the /tests directory for usage examples of most of the included functions.
 This software was developed without the use of AI-generated code. The Continue Agent in Microsoft Visual Studio Code using the GPT-5 mini model (by OpenAI) was used solely to assist in drafting and refining docstrings for documentation. The corresponding guidelines and constraints defined by the author are documented in `AGENTS-docstrings.md` in the [public GitHub repository](https://github.com/geowieland/diffindiff_official).
 
 
-## What's new (v2.3.2)
+## What's new (v2.3.3)
 
 - Extensions:
-  - Re-transform log-transformed outcomes in DiffModel.plot() via parameter 'retransform_log_outcome'
+  - Create treatment interactions via didanalysis.did_analysis() or diddata.DiffData.analysis()

{diffindiff-2.3.2 → diffindiff-2.3.3}/README.md

@@ -19,7 +19,7 @@ Thomas Wieland [ORCID](https://orcid.org/0000-0001-5168-9846) [EMail](mailto:geo
 
 If you use this software, please cite:
 
-Wieland, T. (2026). diffindiff: A Python library for convenient difference-in-differences analyses (Version 2.3.2) [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.18656820
+Wieland, T. (2026). diffindiff: A Python library for convenient difference-in-differences analyses (Version 2.3.3) [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.18656820
 
 
 ## Installation
@@ -165,7 +165,7 @@ See the /tests directory for usage examples of most of the included functions.
 This software was developed without the use of AI-generated code. The Continue Agent in Microsoft Visual Studio Code using the GPT-5 mini model (by OpenAI) was used solely to assist in drafting and refining docstrings for documentation. The corresponding guidelines and constraints defined by the author are documented in `AGENTS-docstrings.md` in the [public GitHub repository](https://github.com/geowieland/diffindiff_official).
 
 
-## What's new (v2.3.2)
+## What's new (v2.3.3)
 
 - Extensions:
-  - Re-transform log-transformed outcomes in DiffModel.plot() via parameter 'retransform_log_outcome'
+  - Create treatment interactions via didanalysis.did_analysis() or diddata.DiffData.analysis()

{diffindiff-2.3.2 → diffindiff-2.3.3}/diffindiff/config.py

@@ -4,15 +4,15 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.0.10
-# Last update: 2026-03-05 21:27
+# Version:     1.0.11
+# Last update: 2026-03-12 19:25
 # Copyright (c) 2025-2026 Thomas Wieland
 #-----------------------------------------------------------------------
 
 # Basic config:
 
 PACKAGE_NAME = "diffindiff"
-PACKAGE_VERSION = "2.3.2"
+PACKAGE_VERSION = "2.3.3"
 
 VERBOSE = False
 

{diffindiff-2.3.2 → diffindiff-2.3.3}/diffindiff/didanalysis.py

@@ -4,8 +4,8 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     2.3.2
-# Last update: 2026-03-06 21:26
+# Version:     2.3.3
+# Last update: 2026-03-12 19:40
 # Copyright (c) 2024-2026 Thomas Wieland
 #-----------------------------------------------------------------------
 
@@ -2088,6 +2088,7 @@ def did_analysis(
     covariates: list = None,
     spillover_treatment: list = None,
     spillover_units: list = None,
+    interactions: dict = None,
     placebo: bool = False,
     confint_alpha = 0.05,
     bonferroni: bool = False,
@@ -2096,8 +2097,8 @@ def did_analysis(
     drop_missing: bool = True,
     missing_replace_by_zero: bool = False,
     fit_by: str = "ols_fit",
-    verbose: bool = config.VERBOSE
-    ):    
+    verbose: bool = False
+    ):
    
     """
     Perform a Difference-in-Differences analysis with a given data frame.
@@ -2154,6 +2155,9 @@ def did_analysis(
         Treatment columns used to construct spillover variables.
     spillover_units : list
         Unit identifiers affected by spillovers.
+    interactions : dict
+        Dictionary with treatment interaction variables to be
+        built from treatment variables.
     placebo : bool
         Run placebo analysis.
     confint_alpha : float
@@ -2171,7 +2175,7 @@ def did_analysis(
     fit_by : str
         Fitting method; e.g., 'ols_fit' or 'ml'.
     verbose : bool, optional
-            If True, print progress messages.
+        If True, print progress messages.
 
     Returns
     -------
@@ -2211,6 +2215,8 @@ def did_analysis(
         spillover_treatment = []
     if spillover_units is None:
         spillover_units = []
+    if interactions is None:
+        interactions = {}
 
     tools.check_columns(
         df = data,
@@ -2624,11 +2630,28 @@ def did_analysis(
         
         did_formula = f"{did_formula} + {covariates_join}"
         
-    indep_vars_no = indep_vars_no+len(spillover_vars)+len(covariates)
+    if len(interactions) > 0:
+        
+        interactions_created = helper.create_interactions(
+            data=data,
+            interactions=interactions,
+            verbose=verbose            
+        )
+
+        data = interactions_created[0]
+
+        did_formula = f"{did_formula} + {interactions_created[1]}"
+        
+        treatment_col.extend(interactions_created[2])
+        
+        no_treatments = no_treatments+len(interactions)
+        
+    indep_vars_no = indep_vars_no+len(spillover_vars)+len(covariates)+len(interactions)
         
     did_formula = did_formula[:-1] if did_formula.endswith(" ") else did_formula
     did_formula = did_formula[:-1] if did_formula.endswith("+") else did_formula
     did_formula = did_formula[:-1] if did_formula.endswith(" ") else did_formula
+    
     if not intercept:
         did_formula = f"{did_formula} - 1"
             
@@ -2754,7 +2777,7 @@ def ddd_analysis(
     drop_missing: bool = True,
     missing_replace_by_zero: bool = False,
     fit_by: str = "ols_fit",
-    verbose: bool = config.VERBOSE
+    verbose: bool = False
     ):
     
     """

{diffindiff-2.3.2 → diffindiff-2.3.3}/diffindiff/didanalysis_helper.py

@@ -4,8 +4,8 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.1.0
-# Last update: 2025-02-28 13:06
+# Version:     1.1.1
+# Last update: 2025-03-12 20:44
 # Copyright (c) 2025-2026 Thomas Wieland
 #-----------------------------------------------------------------------
 
@@ -369,6 +369,121 @@ def create_spillover(
         spillover_treatment_vars_join,
         spillover_treatment_vars
         ]
+    
+def create_interactions(
+    data: pd.DataFrame,
+    interactions: dict = None,
+    verbose: bool = config.VERBOSE
+    ):
+
+    """
+    Create interaction variables by multiplying specified treatment columns.
+
+    Parameters
+    ----------
+    data : pandas.DataFrame
+        Input data frame containing treatment columns.
+    interactions : dict, optional
+        Dictionary defining interaction variables. Each entry should be a
+        mapping with keys "name" (desired new column name) and
+        "treatments" (list of existing treatment column names to multiply).
+    verbose : bool, optional
+        If True, print progress messages.
+
+    Returns
+    -------
+    list
+        [data_with_interactions (DataFrame), join_string (str), interaction_vars (list)]
+
+    Raises
+    ------
+    TypeError
+        If ``interactions`` is not a dict.
+    KeyError
+        If a stated interaction name already exists in `data` or if any
+        referenced treatment column does not exist in `data`.
+    ValueError
+        If fewer than two treatments are provided to build an interaction.
+
+    Examples
+    --------
+    >>> create_interactions(
+    ...     df, 
+    ...     {
+    ...         0: {
+    ...             'name': 'interaction_col', 
+    ...             'treatments': ['treatment1', 'treatment2']
+    ...         }
+    ...     }
+    ... )
+    """
+    
+    if interactions is None:
+        interactions = {}
+        
+    if not isinstance(interactions, dict):
+        raise TypeError("Parameter 'interactions' must be a dict") 
+      
+    interaction_vars = []
+    
+    if len(interactions) > 0:
+        
+        if verbose:
+            print(f"Creating {len(interactions)} interaction variables", end = " ... ")
+        
+        for key, value in interactions.items():
+            
+            interaction_var_name = value["name"]
+            
+            if interaction_var_name in data.columns:
+                raise KeyError(f"Stated column name '{interaction_var_name}' already exists in data frame")
+            
+            interaction_var_name = tools.clean_column_name(interaction_var_name)
+            
+            interaction_vars.append(interaction_var_name)            
+            
+            treatments = value["treatments"]
+            
+            if len (treatments) < 2:
+                raise ValueError(f"To build interaction variables, at least two treatment variables must be stated, not {len(treatments)}")            
+            
+            treatment_cols_not_available = []            
+            
+            for treatment in treatments:
+                if treatment not in data.columns:
+                    treatment_cols_not_available.append(treatment)
+            
+            if len(treatment_cols_not_available) > 0:                    
+                raise KeyError(f"The following column(s) stated do not exist in the data frame: {', '.join(treatment_cols_not_available)}")            
+            
+            treatment1 = treatments[0]
+            
+            data[interaction_var_name] = data[treatment1]
+            
+            for key, treatment in enumerate(treatments):
+                
+                if key == 0:
+                    continue
+                
+                data[interaction_var_name] = data[interaction_var_name]*data[treatment]
+            
+        if verbose:
+            print("OK")
+            
+            if len(interaction_vars) > 0:
+                print(f"NOTE: The following {len(interaction_vars)} interaction variables were created: {', '.join(interaction_vars)}.")
+    
+    else:
+        
+        print("WARNING: Parameter 'interactions' was not set. No interaction variables were created.")
+    
+    interaction_vars_join = ' + '.join(interaction_vars)
+    
+    return [
+        data,
+        interaction_vars_join,
+        interaction_vars
+        ]
 
 def data_diagnostics(
     data: pd.DataFrame,

{diffindiff-2.3.2 → diffindiff-2.3.3}/diffindiff/diddata.py

@@ -4,8 +4,8 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     2.2.2
-# Last update: 2026-03-06 21:27
+# Version:     2.2.3
+# Last update: 2026-03-12 19:34
 # Copyright (c) 2024-2026 Thomas Wieland
 #-----------------------------------------------------------------------
 
@@ -815,7 +815,6 @@ class DiffData:
     def get_did_modeldata_df (self):
 
         """
-
         Return the DiD model data as a DataFrame.
 
         Returns
@@ -845,7 +844,6 @@ class DiffData:
     def get_did_groups(self):
 
         """
-
         Return the stored DiffGroups object.
 
         Returns
@@ -875,7 +873,6 @@ class DiffData:
     def get_did_treatment(self):
 
         """
-
         Return the stored DiffTreatment object.
 
         Returns
@@ -905,7 +902,6 @@ class DiffData:
     def get_unit_time_cols(self):
 
         """
-
         Return the original unit/time column names.
 
         Returns
@@ -935,7 +931,6 @@ class DiffData:
     def get_covariates(self):
 
         """
-
         Return the list of covariate column names.
 
         Returns
@@ -965,7 +960,6 @@ class DiffData:
     def get_treatment_cols(self):
 
         """
-
         Return the stored treatment columns metadata.
 
         Returns
@@ -995,7 +989,6 @@ class DiffData:
     def get_timestamp(self):
 
         """
-
         Return timestamp metadata for the DiffData object.
 
         Returns
@@ -1567,10 +1560,10 @@ class DiffData:
         self.data[4] = unit_time_col_original
         self.data[5] = covariates
         self.data[6] = treatment_cols_new
-        self.data[7][len(self.data[7])] = helper.create_timestamp(function="define_treatment")        
+        self.data[7][len(self.data[7])] = helper.create_timestamp(function="define_treatment")
         
         return self
-
+    
     def add_segmentation(
         self,
         group_benefit: list
@@ -1796,6 +1789,8 @@ class DiffData:
 
         print("=" * total_width)
 
+        return self
+
     def analysis(
         self, 
         log_outcome: bool = False,
@@ -1811,6 +1806,7 @@ class DiffData:
         group_by: str = None,
         spillover_treatment: list = None,
         spillover_units: list = None,
+        interactions: dict = None,
         confint_alpha: float = 0.05,
         bonferroni: bool = False,
         drop_missing: bool = True,
@@ -1850,6 +1846,9 @@ class DiffData:
             Treatments for which to create spillover variables.
         spillover_units : list, optional
             Units to flag as exposed to spillover.
+        interactions : dict
+            Dictionary with treatment interaction variables to be
+            built from treatment variables.
         confint_alpha : float, optional
             Significance level for confidence intervals.
         bonferroni : bool, optional
@@ -1887,6 +1886,8 @@ class DiffData:
             spillover_treatment = []
         if spillover_units is None:
             spillover_units = []
+        if interactions is None:
+            interactions = {}
 
         did_modeldata = self.get_did_modeldata_df()
         outcome_col_original = self.data[3]
@@ -1977,6 +1978,7 @@ class DiffData:
                 covariates = covariates,
                 spillover_treatment = spillover_treatment,
                 spillover_units = spillover_units,
+                interactions = interactions,
                 confint_alpha = confint_alpha,
                 bonferroni = bonferroni,
                 freq = freq,
@@ -2166,6 +2168,7 @@ def merge_data(
         unit_time_col_original,
         [],
         treatment_cols,
+        {},
         timestamp
         )
 

{diffindiff-2.3.2 → diffindiff-2.3.3}/diffindiff.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: diffindiff
-Version: 2.3.2
+Version: 2.3.3
 Summary: diffindiff: Python library for convenient Difference-in-Differences analyses
 Author: Thomas Wieland
 Author-email: geowieland@googlemail.com
@@ -27,7 +27,7 @@ Thomas Wieland [ORCID](https://orcid.org/0000-0001-5168-9846) [EMail](mailto:geo
 
 If you use this software, please cite:
 
-Wieland, T. (2026). diffindiff: A Python library for convenient difference-in-differences analyses (Version 2.3.2) [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.18656820
+Wieland, T. (2026). diffindiff: A Python library for convenient difference-in-differences analyses (Version 2.3.3) [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.18656820
 
 
 ## Installation
@@ -173,7 +173,7 @@ See the /tests directory for usage examples of most of the included functions.
 This software was developed without the use of AI-generated code. The Continue Agent in Microsoft Visual Studio Code using the GPT-5 mini model (by OpenAI) was used solely to assist in drafting and refining docstrings for documentation. The corresponding guidelines and constraints defined by the author are documented in `AGENTS-docstrings.md` in the [public GitHub repository](https://github.com/geowieland/diffindiff_official).
 
 
-## What's new (v2.3.2)
+## What's new (v2.3.3)
 
 - Extensions:
-  - Re-transform log-transformed outcomes in DiffModel.plot() via parameter 'retransform_log_outcome'
+  - Create treatment interactions via didanalysis.did_analysis() or diddata.DiffData.analysis()

{diffindiff-2.3.2 → diffindiff-2.3.3}/setup.py

@@ -7,7 +7,7 @@ def read_README():
     
 setup(
     name='diffindiff',
-    version='2.3.2',
+    version='2.3.3',
     description='diffindiff: Python library for convenient Difference-in-Differences analyses',
     packages=find_packages(include=["diffindiff", "diffindiff.tests"]),
     include_package_data=True,