From 8ce77a1be41e563e70dacd2c5f01dffaefbcb98b Mon Sep 17 00:00:00 2001 From: "Benjamin T. Vincent" Date: Thu, 2 Nov 2023 11:10:59 +0000 Subject: [PATCH] add docstring to RegressionKink class --- causalpy/pymc_experiments.py | 22 ++++++++++++++++++++++ docs/source/_static/interrogate_badge.svg | 6 +++--- 2 files changed, 25 insertions(+), 3 deletions(-) diff --git a/causalpy/pymc_experiments.py b/causalpy/pymc_experiments.py index e4efb83a..16289273 100644 --- a/causalpy/pymc_experiments.py +++ b/causalpy/pymc_experiments.py @@ -958,6 +958,28 @@ def summary(self) -> None: class RegressionKink(ExperimentalDesign): + """ + A class to analyse sharp regression kink experiments. + + :param data: + A pandas dataframe + :param formula: + A statistical model formula + :param kink_point: + A scalar threshold value at which there is a change in the first derivative of + the assignment function + :param model: + A PyMC model + :param running_variable_name: + The name of the predictor variable that the kink_point is based upon + :param epsilon: + A small scalar value which determines how far above and below the kink point to + evaluate the causal impact. + :param bandwidth: + Data outside of the bandwidth (relative to the discontinuity) is not used to fit + the model. + """ + def __init__( self, data: pd.DataFrame, diff --git a/docs/source/_static/interrogate_badge.svg b/docs/source/_static/interrogate_badge.svg index 90d8153e..5b67d546 100644 --- a/docs/source/_static/interrogate_badge.svg +++ b/docs/source/_static/interrogate_badge.svg @@ -1,5 +1,5 @@ - interrogate: 96.7% + interrogate: 97.4% @@ -12,8 +12,8 @@ interrogate interrogate - 96.7% - 96.7% + 97.4% + 97.4%