update summary method to make this work + re-run example notebook

Author: drbenvincent

causalpy/pymc_experiments.py

@@ -992,7 +992,7 @@ def __init__(
         **kwargs,
     ):
         super().__init__(model=model, **kwargs)
-        self.expt_type = "Regression Discontinuity"
+        self.expt_type = "Regression Kink"
         self.data = data
         self.formula = formula
         self.running_variable_name = running_variable_name
@@ -1084,12 +1084,7 @@ def _input_validation(self):
             )
 
     def _is_treated(self, x):
-        """Returns ``True`` if `x` is greater than or equal to the treatment threshold.
-
-        .. warning::
-
-            Assumes treatment is given to those ABOVE the treatment threshold.
-        """
+        """Returns ``True`` if `x` is greater than or equal to the treatment threshold."""  # noqa: E501
         return np.greater_equal(x, self.kink_point)
 
     def plot(self):
@@ -1148,11 +1143,9 @@ def summary(self) -> None:
         print(f"{self.expt_type:=^80}")
         print(f"Formula: {self.formula}")
         print(f"Running variable: {self.running_variable_name}")
-        print(f"Threshold on running variable: {self.kink_point}")
+        print(f"Kink point on running variable: {self.kink_point}")
         print("\nResults:")
-        print(
-            f"Discontinuity at threshold = {self.discontinuity_at_threshold.mean():.2f}"
-        )
+        print(f"Change in slope at kink point = {self.gradient_change.mean():.2f}")
         self.print_coefficients()
 
 

docs/source/notebooks/rkink_pymc.ipynb

@@ -345,6 +345,41 @@
     "We know that the correct gradient change is 2, and that we have correctly recovered it as the posterior distribution is centred around 2."
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "We can also ask for summary information:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 8,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "================================Regression Kink=================================\n",
+      "Formula: y ~ 1 + x + I((x-0.5)*treated)\n",
+      "Running variable: x\n",
+      "Kink point on running variable: 0.5\n",
+      "\n",
+      "Results:\n",
+      "Change in slope at kink point = 1.93\n",
+      "Model coefficients:\n",
+      "Intercept                     -0.01, 94% HDI [-0.02, 0.01]\n",
+      "x                             -0.99, 94% HDI [-1.01, -0.96]\n",
+      "I((x - 0.5) * treated)        1.93, 94% HDI [1.77, 2.10]\n",
+      "sigma                         0.04, 94% HDI [0.03, 0.05]\n"
+     ]
+    }
+   ],
+   "source": [
+    "result1.summary()"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -368,7 +403,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 8,
+   "execution_count": 9,
    "metadata": {},
    "outputs": [
     {
@@ -400,7 +435,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
+   "execution_count": 10,
    "metadata": {},
    "outputs": [
     {
@@ -461,7 +496,7 @@
      "name": "stderr",
      "output_type": "stream",
      "text": [
-      "Sampling 4 chains for 5_000 tune and 1_000 draw iterations (20_000 + 4_000 draws total) took 10 seconds.\n",
+      "Sampling 4 chains for 5_000 tune and 1_000 draw iterations (20_000 + 4_000 draws total) took 11 seconds.\n",
       "Sampling: [beta, sigma, y_hat]\n",
       "Sampling: [y_hat]\n",
       "Sampling: [y_hat]\n",
@@ -510,7 +545,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 10,
+   "execution_count": 11,
    "metadata": {},
    "outputs": [
     {
@@ -542,7 +577,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 11,
+   "execution_count": 12,
    "metadata": {},
    "outputs": [
     {
@@ -576,7 +611,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 12,
+   "execution_count": 13,
    "metadata": {},
    "outputs": [
     {
@@ -611,7 +646,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 13,
+   "execution_count": 14,
    "metadata": {},
    "outputs": [
     {
@@ -709,7 +744,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 14,
+   "execution_count": 15,
    "metadata": {},
    "outputs": [
     {