diff --git a/causalpy/experiments/experiments.py b/causalpy/experiments/base.py similarity index 97% rename from causalpy/experiments/experiments.py rename to causalpy/experiments/base.py index 5971849b..f1b3cd30 100644 --- a/causalpy/experiments/experiments.py +++ b/causalpy/experiments/base.py @@ -16,7 +16,7 @@ """ -class ExperimentalDesign: +class BaseExperiment: """Base class for quasi experimental designs.""" def __init__(self, model=None, **kwargs): diff --git a/causalpy/experiments/diff_in_diff.py b/causalpy/experiments/diff_in_diff.py index 515c6a46..a54dabe8 100644 --- a/causalpy/experiments/diff_in_diff.py +++ b/causalpy/experiments/diff_in_diff.py @@ -27,10 +27,10 @@ from causalpy.skl_models import ScikitLearnModel from causalpy.utils import _is_variable_dummy_coded, convert_to_string -from .experiments import ExperimentalDesign +from .base import BaseExperiment -class DifferenceInDifferences(ExperimentalDesign): +class DifferenceInDifferences(BaseExperiment): """A class to analyse data from Difference in Difference settings. .. note:: diff --git a/causalpy/experiments/instrumental_variable.py b/causalpy/experiments/instrumental_variable.py index 3a04e9ab..ac4d43aa 100644 --- a/causalpy/experiments/instrumental_variable.py +++ b/causalpy/experiments/instrumental_variable.py @@ -23,10 +23,10 @@ from sklearn.linear_model import LinearRegression as sk_lin_reg from causalpy.custom_exceptions import DataException -from .experiments import ExperimentalDesign +from .base import BaseExperiment -class InstrumentalVariable(ExperimentalDesign): +class InstrumentalVariable(BaseExperiment): """ A class to analyse instrumental variable style experiments. diff --git a/causalpy/experiments/inverse_propensity_weighting.py b/causalpy/experiments/inverse_propensity_weighting.py index 03cbaaed..fb5b79d8 100644 --- a/causalpy/experiments/inverse_propensity_weighting.py +++ b/causalpy/experiments/inverse_propensity_weighting.py @@ -25,10 +25,10 @@ from causalpy.custom_exceptions import DataException -from .experiments import ExperimentalDesign +from .base import BaseExperiment -class InversePropensityWeighting(ExperimentalDesign): +class InversePropensityWeighting(BaseExperiment): """ A class to analyse inverse propensity weighting experiments. diff --git a/causalpy/experiments/prepostfit.py b/causalpy/experiments/prepostfit.py index 72a0f7cd..4d383fd0 100644 --- a/causalpy/experiments/prepostfit.py +++ b/causalpy/experiments/prepostfit.py @@ -25,10 +25,10 @@ from causalpy.pymc_models import PyMCModel from causalpy.skl_models import ScikitLearnModel -from .experiments import ExperimentalDesign +from .base import BaseExperiment -class PrePostFit(ExperimentalDesign): +class PrePostFit(BaseExperiment): """ A base class for quasi-experimental designs where parameter estimation is based on just pre-intervention data. This class is not directly invoked by the user. diff --git a/causalpy/experiments/prepostnegd.py b/causalpy/experiments/prepostnegd.py index 8bed1818..e7a31d03 100644 --- a/causalpy/experiments/prepostnegd.py +++ b/causalpy/experiments/prepostnegd.py @@ -26,10 +26,10 @@ from causalpy.skl_models import ScikitLearnModel from causalpy.utils import _is_variable_dummy_coded, round_num -from .experiments import ExperimentalDesign +from .base import BaseExperiment -class PrePostNEGD(ExperimentalDesign): +class PrePostNEGD(BaseExperiment): """ A class to analyse data from pretest/posttest designs diff --git a/causalpy/experiments/regression_discontinuity.py b/causalpy/experiments/regression_discontinuity.py index a0fd10ff..c98002fc 100644 --- a/causalpy/experiments/regression_discontinuity.py +++ b/causalpy/experiments/regression_discontinuity.py @@ -21,7 +21,7 @@ import pandas as pd from patsy import build_design_matrices, dmatrices -from .experiments import ExperimentalDesign +from .base import BaseExperiment from causalpy.pymc_models import PyMCModel from causalpy.skl_models import ScikitLearnModel from causalpy.utils import convert_to_string @@ -32,7 +32,7 @@ from causalpy.utils import _is_variable_dummy_coded -class RegressionDiscontinuity(ExperimentalDesign): +class RegressionDiscontinuity(BaseExperiment): """ A class to analyse sharp regression discontinuity experiments. diff --git a/causalpy/experiments/regression_kink.py b/causalpy/experiments/regression_kink.py index 66bce502..9e0f49c8 100644 --- a/causalpy/experiments/regression_kink.py +++ b/causalpy/experiments/regression_kink.py @@ -22,7 +22,7 @@ import pandas as pd from patsy import build_design_matrices, dmatrices -from .experiments import ExperimentalDesign +from .base import BaseExperiment from causalpy.utils import round_num from causalpy.custom_exceptions import ( DataException, @@ -31,7 +31,7 @@ from causalpy.utils import _is_variable_dummy_coded -class RegressionKink(ExperimentalDesign): +class RegressionKink(BaseExperiment): """Regression Kink experiment class.""" def __init__( diff --git a/docs/source/_static/classes.png b/docs/source/_static/classes.png index 4e048248..3affae30 100644 Binary files a/docs/source/_static/classes.png and b/docs/source/_static/classes.png differ diff --git a/docs/source/_static/packages.png b/docs/source/_static/packages.png index 4f350228..def44298 100644 Binary files a/docs/source/_static/packages.png and b/docs/source/_static/packages.png differ