diffindiff 2.5.1__tar.gz → 2.5.3__tar.gz

{diffindiff-2.5.1 → diffindiff-2.5.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: diffindiff
-Version: 2.5.1
+Version: 2.5.3
 Summary: diffindiff: Python library for convenient Difference-in-Differences analyses
 Author: Thomas Wieland
 Author-email: geowieland@googlemail.com
@@ -22,14 +22,14 @@ Thomas Wieland [ORCID](https://orcid.org/0000-0001-5168-9846) [EMail](mailto:geo
 - 💻 GitHub Repository: [diffindiff_official](https://github.com/geowieland/diffindiff_official)
 - 📄 DOI (Zenodo): [10.5281/zenodo.18656820](https://doi.org/10.5281/zenodo.18656820)
 
-A research note featuring a case study that utilizes the diffindiff library is available on [arXiv](https://arxiv.org/abs/2605.21464).
+A case study that utilizes the diffindiff library is available on [arXiv](https://arxiv.org/abs/2605.21464).
 
 
 ## Citation
 
 If you use this software, please cite:
 
-Wieland, T. (2026). diffindiff: A Python library for convenient difference-in-differences analyses (Version 2.5.1) [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.5.3) [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.18656820
 
 
 ## Installation
@@ -53,6 +53,7 @@ pip install git+https://github.com/geowieland/diffindiff_official.git
   - Define custom treatment and control groups as well as treatment periods
   - Create ready-to-fit DiD data objects
   - Create predictive counterfactuals
+  - Create a synthetic control unit 
 - **DiD analysis**: 
   - Perform standard DiD analysis with pre-post data
   - Perform DiD analysis with two-way fixed effects models
@@ -66,6 +67,7 @@ pip install git+https://github.com/geowieland/diffindiff_official.git
     - Including after-treatment period
   - Perform Triple Difference (DDD) analysis
   - Perform DiD analysis with demeaned data
+  - Perform Synthetic DiD analysis
 - **Diagnosis tools and extensions of analyses**:
   - Add own counterfactuals or create counterfactuals based on machine learning or OLS regression models
   - Bonferroni correction for treatment effects
@@ -177,9 +179,9 @@ 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.5.1)
+## What's new (v2.5.3)
 
+- Extensions
+  - Added optional saving of plots in DiffModel plot methods
 - Bugfixes
-  - In DiffData.create_treatment() and DiffData.create_data(), pre-post designs with after-treatment period (follow-up) now work correctly
-  - DiffModel.plot() nows supports pre-post designs with after-treatment period
-  - Some small stabilizations
+  - Fixed typos in messages

{diffindiff-2.5.1 → diffindiff-2.5.3}/README.md

@@ -14,14 +14,14 @@ Thomas Wieland [ORCID](https://orcid.org/0000-0001-5168-9846) [EMail](mailto:geo
 - 💻 GitHub Repository: [diffindiff_official](https://github.com/geowieland/diffindiff_official)
 - 📄 DOI (Zenodo): [10.5281/zenodo.18656820](https://doi.org/10.5281/zenodo.18656820)
 
-A research note featuring a case study that utilizes the diffindiff library is available on [arXiv](https://arxiv.org/abs/2605.21464).
+A case study that utilizes the diffindiff library is available on [arXiv](https://arxiv.org/abs/2605.21464).
 
 
 ## Citation
 
 If you use this software, please cite:
 
-Wieland, T. (2026). diffindiff: A Python library for convenient difference-in-differences analyses (Version 2.5.1) [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.5.3) [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.18656820
 
 
 ## Installation
@@ -45,6 +45,7 @@ pip install git+https://github.com/geowieland/diffindiff_official.git
   - Define custom treatment and control groups as well as treatment periods
   - Create ready-to-fit DiD data objects
   - Create predictive counterfactuals
+  - Create a synthetic control unit 
 - **DiD analysis**: 
   - Perform standard DiD analysis with pre-post data
   - Perform DiD analysis with two-way fixed effects models
@@ -58,6 +59,7 @@ pip install git+https://github.com/geowieland/diffindiff_official.git
     - Including after-treatment period
   - Perform Triple Difference (DDD) analysis
   - Perform DiD analysis with demeaned data
+  - Perform Synthetic DiD analysis
 - **Diagnosis tools and extensions of analyses**:
   - Add own counterfactuals or create counterfactuals based on machine learning or OLS regression models
   - Bonferroni correction for treatment effects
@@ -169,9 +171,9 @@ 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.5.1)
+## What's new (v2.5.3)
 
+- Extensions
+  - Added optional saving of plots in DiffModel plot methods
 - Bugfixes
-  - In DiffData.create_treatment() and DiffData.create_data(), pre-post designs with after-treatment period (follow-up) now work correctly
-  - DiffModel.plot() nows supports pre-post designs with after-treatment period
-  - Some small stabilizations
+  - Fixed typos in messages

{diffindiff-2.5.1 → diffindiff-2.5.3}/diffindiff/config.py

@@ -4,15 +4,15 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.0.22
-# Last update: 2026-07-10 11:36
+# Version:     1.0.24
+# Last update: 2026-07-25 12:31
 # Copyright (c) 2025-2026 Thomas Wieland
 #-----------------------------------------------------------------------
 
 # Basic config:
 
 PACKAGE_NAME = "diffindiff"
-PACKAGE_VERSION = "2.5.1"
+PACKAGE_VERSION = "2.5.3"
 
 VERBOSE = False
 

{diffindiff-2.5.1 → diffindiff-2.5.3}/diffindiff/didanalysis.py

@@ -4,8 +4,8 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     2.4.2
-# Last update: 2026-07-10 11:30
+# Version:     2.4.4
+# Last update: 2026-07-23 19:42
 # Copyright (c) 2024-2026 Thomas Wieland
 #-----------------------------------------------------------------------
 
@@ -782,7 +782,7 @@ class DiffModel:
       
         if len(no_control_conditions) > 0:
             if len(no_control_conditions) == 1:
-                print(f"NOTE: Treatment {no_control_conditions[0]} has no control conditions.")
+                print(f"NOTE: Treatment '{no_control_conditions[0]}' has no control conditions.")
             else:
                 print(f"NOTE: Treatments {', '.join(no_control_conditions)} have no control conditions.")  
 
@@ -829,7 +829,9 @@ class DiffModel:
         plot_size: list = [7, 6],
         scale_plot: bool = True,
         show_central_tendency: bool = False,
-        central_tendency: str = "mean"
+        central_tendency: str = "mean",
+        save_fig: str = None,
+        save_fig_kwargs: dict = {}
         ):
            
         """
@@ -869,6 +871,10 @@ class DiffModel:
             Show mean/median line for estimates. Default is False.
         central_tendency : str, optional
             'mean' or 'median' for central tendency if shown. Default is 'mean'.
+        save_fig : str, optional
+            If not none, filename of plot to be saved.
+        save_fig_kwargs : dict, optional
+            Optional arguments for plt.savefig() if save_fig is not None.
 
         Returns
         -------
@@ -1006,6 +1012,9 @@ class DiffModel:
         if plot_grid:
             plt.grid(True)
         
+        if save_fig is not None and isinstance(save_fig, str):
+            plt.savefig(save_fig, **save_fig_kwargs)
+        
         plt.show()
 
         return self
@@ -1422,10 +1431,15 @@ class DiffModel:
         model_data_c[time_col] = pd.to_datetime(model_data_c[time_col])
         model_data_c[unit_col] = model_data_c[unit_col].astype(str)
 
-        units_random_sample = model_data_c[unit_col].sample(
-            n = int(round(divide*control_group_N*resample, 0)), 
-            random_state = random_state
-            ).astype(str).tolist()
+        if control_group_N < 2:
+            print(f"WARNING: Model includes one control unit only: '{control_group[0]}'. Placebo analysis requires size of control group >1. Original model is returned.")
+            return self
+
+        else:
+            units_random_sample = model_data_c[unit_col].sample(
+                n = int(round(divide*control_group_N*resample, 0)), 
+                random_state = random_state
+                ).astype(str).tolist()
 
         model_data_c[TG_col_] = 0
         model_data_c.loc[(model_data_c[unit_col].isin(units_random_sample)), TG_col_] = 1
@@ -1468,7 +1482,9 @@ class DiffModel:
         y_lim = None,
         plot_title: str = "Treatment time",
         plot_symbol: str = "o",
-        treatment_group_only: bool = True
+        treatment_group_only: bool = True,
+        save_fig: str = None,
+        save_fig_kwargs: dict = {}
         ):
 
         """
@@ -1492,6 +1508,10 @@ class DiffModel:
             Symbol used for treatment timing points. Default is 'o'.
         treatment_group_only : bool, optional
             If True, only plot treated units.
+        save_fig : str, optional
+            If not none, filename of plot to be saved.
+        save_fig_kwargs : dict, optional
+            Optional arguments for plt.savefig() if save_fig is not None.
 
         Returns
         -------
@@ -1565,6 +1585,9 @@ class DiffModel:
         
         if y_lim is not None:
             ax.set_ylim(y_lim)
+        
+        if save_fig is not None and isinstance(save_fig, str):
+            plt.savefig(save_fig, **save_fig_kwargs)
 
         plt.show()
 
@@ -1590,7 +1613,9 @@ class DiffModel:
         pre_post_ticks: list = ["Pre", "Post"],
         pre_post_barplot = False,
         pre_post_bar_width = 0.5,
-        retransform_log_outcome: bool = False
+        retransform_log_outcome: bool = False,
+        save_fig: str = None,
+        save_fig_kwargs: dict = {}
         ):
 
         """
@@ -1637,6 +1662,10 @@ class DiffModel:
         retransform_log_outcome : bool, optional
             If outcome was log-transformed, retransform to original scale for plotting. 
             Default is False.
+        save_fig : str, optional
+            If not none, filename of plot to be saved.
+        save_fig_kwargs : dict, optional
+            Optional arguments for plt.savefig() if save_fig is not None.
 
         Returns
         -------
@@ -2039,7 +2068,10 @@ class DiffModel:
 
         if y_lim is not None:
             ax.set_ylim(y_lim)
-            
+        
+        if save_fig is not None and isinstance(save_fig, str):
+            plt.savefig(save_fig, **save_fig_kwargs)
+        
         plt.show()
         
         return model_data_TG_CG    
@@ -2058,7 +2090,9 @@ class DiffModel:
         plot_legend: bool = True,
         plot_grid: bool = True,
         plot_size: list = [12, 6],
-        retransform_log_outcome: bool = False
+        retransform_log_outcome: bool = False,
+        save_fig: str = None,
+        save_fig_kwargs: dict = {}
         ):
 
         """
@@ -2093,6 +2127,10 @@ class DiffModel:
         retransform_log_outcome : bool, optional
             If outcome was log-transformed, retransform to original scale for plotting. 
             Default is False.
+        save_fig : str, optional
+            If not none, filename of plot to be saved.
+        save_fig_kwargs : dict, optional
+            Optional arguments for plt.savefig() if save_fig is not None.
 
         Returns
         -------
@@ -2222,6 +2260,9 @@ class DiffModel:
         
         if y_lim is not None:
             ax.set_ylim(y_lim)
+        
+        if save_fig is not None and isinstance(save_fig, str):
+            plt.savefig(save_fig, **save_fig_kwargs)
             
         plt.show()
 

{diffindiff-2.5.1 → diffindiff-2.5.3}/diffindiff/didanalysis_helper.py

@@ -4,8 +4,8 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     1.2.2
-# Last update: 2026-07-02 20:18
+# Version:     1.2.3
+# Last update: 2026-07-14 19:44
 # Copyright (c) 2025-2026 Thomas Wieland
 #-----------------------------------------------------------------------
 

{diffindiff-2.5.1 → diffindiff-2.5.3}/diffindiff/diddata.py

@@ -4,8 +4,8 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     2.3.1
-# Last update: 2026-07-10 11:37
+# Version:     2.3.2
+# Last update: 2026-07-16 18:52
 # Copyright (c) 2024-2026 Thomas Wieland
 #-----------------------------------------------------------------------
 
@@ -815,7 +815,8 @@ class DiffData:
         unit_time_col_original,
         covariates,
         treatment_cols,
-        timestamp
+        timestamp,
+        synthetic_control
         ):
 
         """
@@ -840,6 +841,8 @@ class DiffData:
             Mapping of treatment columns metadata.
         timestamp : dict
             Timestamp metadata.
+        synthetic_control : dict
+            If included, data for a synthetic control unit, else None.
         Returns
         -------
         None
@@ -855,7 +858,8 @@ class DiffData:
             unit_time_col_original,
             covariates,
             treatment_cols,
-            timestamp
+            timestamp,
+            synthetic_control
             ]
 
     def get_did_modeldata_df (self):
@@ -1060,6 +1064,46 @@ class DiffData:
         """
 
         return self.data[7]
+    
+    def get_synthetic_control_weightings(self):
+
+        """
+        Return weightings of the synthetic control unit (if included in the DiffData object).
+
+        Returns
+        -------
+        pandas.DataFrame
+            Weighting by control unit.
+        
+        Examples
+        --------
+        >>> my_diffdata.get_synthetic_control_weightings()
+        """
+
+        if len(self.data[8]) > 0:
+            return self.data[8]["weights"]
+        else:
+            print("The DiffData object does not include a synthetic control unit.")
+            
+    def get_synthetic_control_fitmetrics(self):
+
+        """
+        Return fit metrics of the synthetic control unit (if included in the DiffData object).
+
+        Returns
+        -------
+        list
+            Fit metrics (dict) and data points with residuals (pandas.DataFrame).
+        
+        Examples
+        --------
+        >>> my_diffdata.get_synthetic_control_fitmetrics()
+        """
+
+        if len(self.data[8]) > 0:
+            return self.data[8]["fit_metrics"]
+        else:
+            print("The DiffData object does not include a synthetic control unit.")
 
     def add_covariates(
         self, 
@@ -2033,6 +2077,14 @@ class DiffData:
             verbose = False
             )
         
+        self.data[7] = helper.create_timestamp(function="add_synthetic")
+        
+        self.data[8] = {
+            "weights": weights_pd,
+            "fit_metrics": synthetic_fit_metrics,
+            "process_unit": process_unit
+        }
+        
         return self
  
     def summary(self):
@@ -2489,7 +2541,8 @@ def merge_data(
         unit_time_col_original,
         [],
         treatment_cols,
-        timestamp
+        timestamp,
+        {}
         )
 
     if verbose:

{diffindiff-2.5.1 → diffindiff-2.5.3}/diffindiff/didtools.py

@@ -4,8 +4,8 @@
 # Author:      Thomas Wieland 
 #              ORCID: 0000-0001-5168-9846
 #              mail: geowieland@googlemail.com              
-# Version:     2.2.4
-# Last update: 2026-04-28 21:45
+# Version:     2.2.5
+# Last update: 2026-07-23 19:34
 # Copyright (c) 2025-2026 Thomas Wieland
 #-----------------------------------------------------------------------
 
@@ -540,10 +540,10 @@ def is_simultaneous(
             print("OK")
 
         if not simultaneous and data_isnotreatment[0]:
-            print(f"NOTE: treatment '{treatment_col}' is not simultaneous.")
+            print(f"NOTE: Treatment '{treatment_col}' is not simultaneous.")
 
         if simultaneous and not data_isnotreatment[0]:
-            print(f"WARNING: treatment '{treatment_col}' is simultaneous and does not include a {config.NO_TREATMENT_CG_DESCRIPTION}")
+            print(f"WARNING: Treatment '{treatment_col}' is simultaneous and does not include a {config.NO_TREATMENT_CG_DESCRIPTION}")
 
     return simultaneous
 

{diffindiff-2.5.1 → diffindiff-2.5.3}/diffindiff.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: diffindiff
-Version: 2.5.1
+Version: 2.5.3
 Summary: diffindiff: Python library for convenient Difference-in-Differences analyses
 Author: Thomas Wieland
 Author-email: geowieland@googlemail.com
@@ -22,14 +22,14 @@ Thomas Wieland [ORCID](https://orcid.org/0000-0001-5168-9846) [EMail](mailto:geo
 - 💻 GitHub Repository: [diffindiff_official](https://github.com/geowieland/diffindiff_official)
 - 📄 DOI (Zenodo): [10.5281/zenodo.18656820](https://doi.org/10.5281/zenodo.18656820)
 
-A research note featuring a case study that utilizes the diffindiff library is available on [arXiv](https://arxiv.org/abs/2605.21464).
+A case study that utilizes the diffindiff library is available on [arXiv](https://arxiv.org/abs/2605.21464).
 
 
 ## Citation
 
 If you use this software, please cite:
 
-Wieland, T. (2026). diffindiff: A Python library for convenient difference-in-differences analyses (Version 2.5.1) [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.5.3) [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.18656820
 
 
 ## Installation
@@ -53,6 +53,7 @@ pip install git+https://github.com/geowieland/diffindiff_official.git
   - Define custom treatment and control groups as well as treatment periods
   - Create ready-to-fit DiD data objects
   - Create predictive counterfactuals
+  - Create a synthetic control unit 
 - **DiD analysis**: 
   - Perform standard DiD analysis with pre-post data
   - Perform DiD analysis with two-way fixed effects models
@@ -66,6 +67,7 @@ pip install git+https://github.com/geowieland/diffindiff_official.git
     - Including after-treatment period
   - Perform Triple Difference (DDD) analysis
   - Perform DiD analysis with demeaned data
+  - Perform Synthetic DiD analysis
 - **Diagnosis tools and extensions of analyses**:
   - Add own counterfactuals or create counterfactuals based on machine learning or OLS regression models
   - Bonferroni correction for treatment effects
@@ -177,9 +179,9 @@ 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.5.1)
+## What's new (v2.5.3)
 
+- Extensions
+  - Added optional saving of plots in DiffModel plot methods
 - Bugfixes
-  - In DiffData.create_treatment() and DiffData.create_data(), pre-post designs with after-treatment period (follow-up) now work correctly
-  - DiffModel.plot() nows supports pre-post designs with after-treatment period
-  - Some small stabilizations
+  - Fixed typos in messages

{diffindiff-2.5.1 → diffindiff-2.5.3}/setup.py

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