Skip to content

Commit

Permalink
change experiment.py::ExperimentalDesign to base.py::BaseExperiment
Browse files Browse the repository at this point in the history
  • Loading branch information
drbenvincent committed Jul 11, 2024
1 parent 47d4479 commit 70e58f8
Show file tree
Hide file tree
Showing 10 changed files with 15 additions and 15 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"""


class ExperimentalDesign:
class BaseExperiment:
"""Base class for quasi experimental designs."""

def __init__(self, model=None, **kwargs):
Expand Down
4 changes: 2 additions & 2 deletions causalpy/experiments/diff_in_diff.py
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down
4 changes: 2 additions & 2 deletions causalpy/experiments/instrumental_variable.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions causalpy/experiments/inverse_propensity_weighting.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions causalpy/experiments/prepostfit.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions causalpy/experiments/prepostnegd.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions causalpy/experiments/regression_discontinuity.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions causalpy/experiments/regression_kink.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -31,7 +31,7 @@
from causalpy.utils import _is_variable_dummy_coded


class RegressionKink(ExperimentalDesign):
class RegressionKink(BaseExperiment):
"""Regression Kink experiment class."""

def __init__(
Expand Down
Binary file modified docs/source/_static/classes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/_static/packages.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 70e58f8

Please sign in to comment.