update docs with concrete tests

Author: christopher-wild

causal_testing/json_front/json_class.py

@@ -102,7 +102,7 @@ def run_json_tests(self, effects: dict, estimators: dict, f_flag: bool = False,
                 self._append_to_file(msg, logging.INFO)
             else:
                 outcome_variable = next(
-                    iter(test["expectedEffect"])
+                    iter(test["expected_effect"])
                 )  # Take first key from dictionary of expected effect
                 base_test_case = BaseTestCase(
                     treatment_variable=self.variables["inputs"][test["treatment_variable"]],
@@ -111,7 +111,7 @@ def run_json_tests(self, effects: dict, estimators: dict, f_flag: bool = False,
 
                 causal_test_case = CausalTestCase(
                     base_test_case=base_test_case,
-                    expected_causal_effect=effects[test["expectedEffect"][outcome_variable]],
+                    expected_causal_effect=effects[test["expected_effect"][outcome_variable]],
                     control_value=test["control_value"],
                     treatment_value=test["treatment_value"],
                     estimate_type=test["estimate_type"],
@@ -141,7 +141,7 @@ def _create_abstract_test_case(self, test, mutates, effects):
             treatment_variable=next(self.scenario.variables[v] for v in test["mutations"]),
             expected_causal_effect={
                 self.scenario.variables[variable]: effects[effect]
-                for variable, effect in test["expectedEffect"].items()
+                for variable, effect in test["expected_effect"].items()
             },
             effect_modifiers={self.scenario.variables[v] for v in test["effect_modifiers"]}
             if "effect_modifiers" in test

docs/source/frontends/json_front_end.rst

@@ -21,17 +21,28 @@ Use case specific information is also declared here such as the paths to the rel
 
 causal_tests.json
 -----------------
-`examples/poisson/causal_tests.json <https://github.com/CITCOM-project/CausalTestingFramework/blob/main/examples/poisson/causal_tests.json>`_ contains python code written by the user to implement scenario specific features
-is the JSON file that allows for the easy specification of multiple causal tests.
+`examples/poisson/causal_tests.json <https://github.c#om/CITCOM-project/CausalTestingFramework/blob/main/examples/poisson/causal_tests.json>`_ contains python code written by the user to implement scenario specific features
+is the JSON file that allows for the easy specification of multiple causal tests. Tests can be specified two ways; firstly by specifying a mutation lke in the example tests with the following structure:
 Each test requires:
-1. Test name
-2. Mutations
-3. Estimator
-4. Estimate_type
-5. Effect modifiers
-6. Expected effects
-7. Skip: boolean that if set true the test won't be executed and will be skipped
 
+#. name
+#. mutations
+#. estimator
+#. estimate_type
+#. effect_modifiers
+#. expected_effects
+#. skip: boolean that if set true the test won't be executed and will be skipped
+
+The second method of specifying a test is to specify the test in a concrete form with the following structure:
+
+#. name
+#. treatment_variable
+#. control_value
+#. treatment_value
+#. estimator
+#. estimate_type
+#. expected_effect
+#. skip
 
 Run Commands
 ------------

tests/json_front_tests/test_json_class.py

@@ -83,7 +83,7 @@ def test_f_flag(self):
                     "estimator": "LinearRegressionEstimator",
                     "estimate_type": "ate",
                     "effect_modifiers": [],
-                    "expectedEffect": {"test_output": "NoEffect"},
+                    "expected_effect": {"test_output": "NoEffect"},
                     "skip": False,
                 }
             ]
@@ -107,7 +107,7 @@ def test_run_json_tests_from_json(self):
                     "estimator": "LinearRegressionEstimator",
                     "estimate_type": "ate",
                     "effect_modifiers": [],
-                    "expectedEffect": {"test_output": "NoEffect"},
+                    "expected_effect": {"test_output": "NoEffect"},
                     "skip": False,
                 }
             ]
@@ -137,7 +137,7 @@ def test_run_concrete_json_testcase(self):
                     "treatment_value": 1,
                     "estimator": "LinearRegressionEstimator",
                     "estimate_type": "ate",
-                    "expectedEffect": {"test_output": "NoEffect"},
+                    "expected_effect": {"test_output": "NoEffect"},
                     "skip": False,
                 }
             ]