Merge pull request #193 from pymc-labs/rename-class

rename `TimeSeriesExperiment` class to `PrePostFit`

Author: drbenvincent

causalpy/pymc_experiments.py

@@ -53,8 +53,9 @@ def print_coefficients(self):
         )
 
 
-class TimeSeriesExperiment(ExperimentalDesign):
-    """A class to analyse time series quasi-experiments"""
+class PrePostFit(ExperimentalDesign):
+    """A class to analyse quasi-experiments where parameter estimation is based on just
+    the pre-intervention data."""
 
     def __init__(
         self,
@@ -242,8 +243,8 @@ def summary(self):
         self.print_coefficients()
 
 
-class SyntheticControl(TimeSeriesExperiment):
-    """A wrapper around the TimeSeriesExperiment class"""
+class SyntheticControl(PrePostFit):
+    """A wrapper around the PrePostFit class"""
 
     expt_type = "Synthetic Control"
 

causalpy/skl_experiments.py

@@ -20,7 +20,10 @@ def __init__(self, model=None, **kwargs):
             raise ValueError("fitting_model not set or passed.")
 
 
-class TimeSeriesExperiment(ExperimentalDesign):
+class PrePostFit(ExperimentalDesign):
+    """A class to analyse quasi-experiments where parameter estimation is based on just
+    the pre-intervention data."""
+
     def __init__(
         self,
         data,
@@ -148,8 +151,8 @@ def plot_coeffs(self):
         )
 
 
-class SyntheticControl(TimeSeriesExperiment):
-    """A wrapper around the TimeSeriesExperiment class"""
+class SyntheticControl(PrePostFit):
+    """A wrapper around the PrePostFit class"""
 
     def plot(self, plot_predictors=False):
         """Plot the results"""