Renamed CausalTestOutcome to CausalEffect

Author: jmafoster1

causal_testing/main.py

@@ -17,7 +17,7 @@
 from causal_testing.specification.causal_specification import CausalSpecification
 from causal_testing.testing.causal_test_case import CausalTestCase
 from causal_testing.testing.base_test_case import BaseTestCase
-from causal_testing.testing.causal_test_outcome import NoEffect, SomeEffect, Positive, Negative
+from causal_testing.testing.causal_effect import NoEffect, SomeEffect, Positive, Negative
 from causal_testing.testing.causal_test_result import CausalTestResult, TestValue
 from causal_testing.estimation.linear_regression_estimator import LinearRegressionEstimator
 from causal_testing.estimation.logistic_regression_estimator import LogisticRegressionEstimator

causal_testing/testing/causal_test_outcome.py renamed to causal_testing/testing/causal_effect.py

@@ -1,5 +1,5 @@
 # pylint: disable=too-few-public-methods
-"""This module contains the CausalTestOutcome abstract class, as well as the concrete extension classes:
+"""This module contains the CausalEffect abstract class, as well as the concrete extension classes:
 ExactValue, Positive, Negative, SomeEffect, NoEffect"""
 
 from abc import ABC, abstractmethod
@@ -9,7 +9,7 @@
 from causal_testing.testing.causal_test_result import CausalTestResult
 
 
-class CausalTestOutcome(ABC):
+class CausalEffect(ABC):
     """An abstract class representing an expected causal effect."""
 
     @abstractmethod
@@ -23,7 +23,7 @@ def __str__(self) -> str:
         return type(self).__name__
 
 
-class SomeEffect(CausalTestOutcome):
+class SomeEffect(CausalEffect):
     """An extension of TestOutcome representing that the expected causal effect should not be zero."""
 
     def apply(self, res: CausalTestResult) -> bool:
@@ -41,7 +41,7 @@ def apply(self, res: CausalTestResult) -> bool:
         raise ValueError(f"Test Value type {res.test_value.type} is not valid for this TestOutcome")
 
 
-class NoEffect(CausalTestOutcome):
+class NoEffect(CausalEffect):
     """An extension of TestOutcome representing that the expected causal effect should be zero."""
 
     def __init__(self, atol: float = 1e-10, ctol: float = 0.05):
@@ -73,7 +73,7 @@ def apply(self, res: CausalTestResult) -> bool:
         raise ValueError(f"Test Value type {res.test_value.type} is not valid for this TestOutcome")
 
 
-class ExactValue(CausalTestOutcome):
+class ExactValue(CausalEffect):
     """An extension of TestOutcome representing that the expected causal effect should be a specific value."""
 
     def __init__(self, value: float, atol: float = None, ci_low: float = None, ci_high: float = None):

causal_testing/testing/causal_test_case.py

@@ -4,7 +4,7 @@
 from typing import Any
 
 from causal_testing.specification.variable import Variable
-from causal_testing.testing.causal_test_outcome import CausalTestOutcome
+from causal_testing.testing.causal_effect import CausalEffect
 from causal_testing.testing.base_test_case import BaseTestCase
 from causal_testing.estimation.abstract_estimator import Estimator
 from causal_testing.testing.causal_test_result import CausalTestResult, TestValue
@@ -26,7 +26,7 @@ def __init__(
         # pylint: disable=too-many-arguments
         self,
         base_test_case: BaseTestCase,
-        expected_causal_effect: CausalTestOutcome,
+        expected_causal_effect: CausalEffect,
         estimate_type: str = "ate",
         estimate_params: dict = None,
         effect_modifier_configuration: dict[Variable:Any] = None,

dafni/main_dafni.py

@@ -10,7 +10,7 @@
 import pandas as pd
 from causal_testing.specification.scenario import Scenario
 from causal_testing.specification.variable import Input, Output
-from causal_testing.testing.causal_test_outcome import Positive, Negative, NoEffect, SomeEffect
+from causal_testing.testing.causal_effect import Positive, Negative, NoEffect, SomeEffect
 from causal_testing.estimation.linear_regression_estimator import LinearRegressionEstimator
 from causal_testing.estimation.logistic_regression_estimator import LogisticRegressionEstimator
 from causal_testing.json_front.json_class import JsonUtility

docs/source/usage.rst

@@ -44,7 +44,7 @@ the given output and input and the desired effect. This information is the minim
 
    from causal_testing.testing.base_test_case import BaseTestCase
    from causal_testing.testing.causal_test_case import CausalTestCase
-   from causal_testing.testing.causal_test_outcome import Positive
+   from causal_testing.testing.causal_effect import Positive
    from causal_testing.testing.effect import Effect
 
    base_test_case = BaseTestCase(

examples/covasim_/doubling_beta/example_beta.py

@@ -7,7 +7,7 @@
 import numpy as np
 from causal_testing.specification.variable import Input, Output
 from causal_testing.testing.causal_test_case import CausalTestCase
-from causal_testing.testing.causal_test_outcome import Positive
+from causal_testing.testing.causal_effect import Positive
 from causal_testing.estimation.linear_regression_estimator import LinearRegressionEstimator
 from causal_testing.testing.base_test_case import BaseTestCase
 

examples/covasim_/vaccinating_elderly/example_vaccine.py

@@ -7,7 +7,7 @@
 from causal_testing.specification.variable import Input, Output
 from causal_testing.specification.causal_specification import CausalSpecification
 from causal_testing.testing.causal_test_case import CausalTestCase
-from causal_testing.testing.causal_test_outcome import Positive, Negative, NoEffect
+from causal_testing.testing.causal_effect import Positive, Negative, NoEffect
 from causal_testing.estimation.linear_regression_estimator import LinearRegressionEstimator
 from causal_testing.testing.base_test_case import BaseTestCase
 

examples/lr91/example_max_conductances.py

@@ -6,7 +6,7 @@
 from causal_testing.specification.variable import Input, Output
 from causal_testing.specification.causal_specification import CausalSpecification
 from causal_testing.testing.causal_test_case import CausalTestCase
-from causal_testing.testing.causal_test_outcome import Positive, Negative, NoEffect
+from causal_testing.testing.causal_effect import Positive, Negative, NoEffect
 from causal_testing.estimation.linear_regression_estimator import LinearRegressionEstimator
 from causal_testing.testing.base_test_case import BaseTestCase
 from matplotlib.pyplot import rcParams

examples/poisson-line-process/example_pure_python.py

@@ -8,7 +8,7 @@
 from causal_testing.specification.variable import Input, Output
 from causal_testing.specification.causal_specification import CausalSpecification
 from causal_testing.testing.causal_test_case import CausalTestCase
-from causal_testing.testing.causal_test_outcome import ExactValue, Positive
+from causal_testing.testing.causal_effect import ExactValue, Positive
 from causal_testing.estimation.linear_regression_estimator import LinearRegressionEstimator
 from causal_testing.estimation.abstract_estimator import Estimator
 from causal_testing.testing.base_test_case import BaseTestCase

tests/testing_tests/test_causal_test_adequacy.py

@@ -9,7 +9,7 @@
 from causal_testing.testing.base_test_case import BaseTestCase
 from causal_testing.testing.causal_test_case import CausalTestCase
 from causal_testing.testing.causal_test_adequacy import DAGAdequacy
-from causal_testing.testing.causal_test_outcome import NoEffect, SomeEffect
+from causal_testing.testing.causal_effect import NoEffect, SomeEffect
 from causal_testing.specification.scenario import Scenario
 from causal_testing.testing.causal_test_adequacy import DataAdequacy
 from causal_testing.specification.variable import Input, Output