Merge pull request #191 from CITCOM-project/validation_move

Utils Package

Author: christopher-wild

causal_testing/utils/__init__.py

@@ -8,7 +8,8 @@
 class CausalValidator:
     """A suite of validation tools to perform Quantitive Bias Analysis to back up causal claims"""
 
-    def estimate_robustness(self, model: RegressionResultsWrapper, q=1, alpha=1):
+    @staticmethod
+    def estimate_robustness(model: RegressionResultsWrapper, q=1, alpha=1):
         """Calculate the robustness of a linear regression model. This allow
         the user to identify how large an unidentified confounding variable
         would need to be to nullify the causal relationship under test."""
@@ -24,7 +25,8 @@ def estimate_robustness(self, model: RegressionResultsWrapper, q=1, alpha=1):
 
         return rv
 
-    def estimate_e_value(self, risk_ratio: float) -> float:
+    @staticmethod
+    def estimate_e_value(risk_ratio: float) -> float:
         """Calculate the E value from a risk ratio. This allow
         the user to identify how large a risk an unidentified confounding
         variable would need to be to nullify the causal relationship
@@ -36,7 +38,8 @@ def estimate_e_value(self, risk_ratio: float) -> float:
         risk_ratio_prime = 1 / risk_ratio
         return risk_ratio_prime + math.sqrt(risk_ratio_prime * (risk_ratio_prime - 1))
 
-    def estimate_e_value_using_ci(self, risk_ratio: float, confidence_intervals: tuple[float, float]) -> float:
+    @staticmethod
+    def estimate_e_value_using_ci(risk_ratio: float, confidence_intervals: tuple[float, float]) -> float:
         """Calculate the E value from a risk ratio and it's confidence intervals.
         This allow the user to identify how large a risk an unidentified
         confounding variable would need to be to nullify the causal relationship

causal_testing/testing/validation.py renamed to causal_testing/utils/validation.py

@@ -2,7 +2,7 @@
 from causal_testing.testing.causal_test_outcome import ExactValue, SomeEffect, Positive, Negative, NoEffect
 from causal_testing.testing.causal_test_result import CausalTestResult, TestValue
 from causal_testing.testing.estimators import LinearRegressionEstimator
-from causal_testing.testing.validation import CausalValidator
+from causal_testing.utils.validation import CausalValidator
 
 
 class TestCausalTestOutcome(unittest.TestCase):

tests/testing_tests/test_causal_test_outcome.py

@@ -9,7 +9,7 @@
     InstrumentalVariableEstimator,
 )
 from causal_testing.specification.variable import Input
-from causal_testing.testing.validation import CausalValidator
+from causal_testing.utils.validation import CausalValidator
 
 
 def plot_results_df(df):