add description of round_to kwarg to docstrings

Author: drbenvincent

causalpy/pymc_experiments.py

@@ -234,6 +234,9 @@ def _input_validation(self, data, treatment_time):
     def plot(self, counterfactual_label="Counterfactual", round_to=None, **kwargs):
         """
         Plot the results
+
+        :param round_to:
+            Number of decimals used to round results. Defaults to 2. Use "none" to return raw numbers.
         """
         fig, ax = plt.subplots(3, 1, sharex=True, figsize=(7, 8))
 
@@ -419,7 +422,11 @@ class SyntheticControl(PrePostFit):
     expt_type = "Synthetic Control"
 
     def plot(self, plot_predictors=False, **kwargs):
-        """Plot the results"""
+        """Plot the results
+
+        :param round_to:
+            Number of decimals used to round results. Defaults to 2. Use "none" to return raw numbers.
+        """
         fig, ax = super().plot(counterfactual_label="Synthetic control", **kwargs)
         if plot_predictors:
             # plot control units as well
@@ -585,7 +592,9 @@ def _input_validation(self):
 
     def plot(self, round_to=None):
         """Plot the results.
-        Creating the combined mean + HDI legend entries is a bit involved.
+
+        :param round_to:
+            Number of decimals used to round results. Defaults to 2. Use "none" to return raw numbers.
         """
         fig, ax = plt.subplots()
 
@@ -902,6 +911,9 @@ def _is_treated(self, x):
     def plot(self, round_to=None):
         """
         Plot the results
+
+        :param round_to:
+            Number of decimals used to round results. Defaults to 2. Use "none" to return raw numbers.
         """
         fig, ax = plt.subplots()
         # Plot raw data
@@ -1116,6 +1128,9 @@ def _is_treated(self, x):
     def plot(self, round_to=None):
         """
         Plot the results
+
+        :param round_to:
+            Number of decimals used to round results. Defaults to 2. Use "none" to return raw numbers.
         """
         fig, ax = plt.subplots()
         # Plot raw data
@@ -1305,7 +1320,11 @@ def _input_validation(self) -> None:
             )
 
     def plot(self, round_to=None):
-        """Plot the results"""
+        """Plot the results
+
+        :param round_to:
+            Number of decimals used to round results. Defaults to 2. Use "none" to return raw numbers.
+        """
         fig, ax = plt.subplots(
             2, 1, figsize=(7, 9), gridspec_kw={"height_ratios": [3, 1]}
         )

causalpy/skl_experiments.py

@@ -116,7 +116,11 @@ def __init__(
         self.post_impact_cumulative = np.cumsum(self.post_impact)
 
     def plot(self, counterfactual_label="Counterfactual", round_to=None, **kwargs):
-        """Plot experiment results"""
+        """Plot experiment results
+
+        :param round_to:
+            Number of decimals used to round results. Defaults to 2. Use "none" to return raw numbers.
+        """
         fig, ax = plt.subplots(3, 1, sharex=True, figsize=(7, 8))
 
         ax[0].plot(self.datapre.index, self.pre_y, "k.")
@@ -263,7 +267,11 @@ class SyntheticControl(PrePostFit):
     """
 
     def plot(self, plot_predictors=False, round_to=None, **kwargs):
-        """Plot the results"""
+        """Plot the results
+
+        :param round_to:
+            Number of decimals used to round results. Defaults to 2. Use "none" to return raw numbers.
+        """
         fig, ax = super().plot(
             counterfactual_label="Synthetic control", round_to=round_to, **kwargs
         )
@@ -404,7 +412,11 @@ def __init__(
         self.causal_impact = self.y_pred_treatment[1] - self.y_pred_counterfactual[0]
 
     def plot(self, round_to=None):
-        """Plot results"""
+        """Plot results
+
+        :param round_to:
+            Number of decimals used to round results. Defaults to 2. Use "none" to return raw numbers.
+        """
         fig, ax = plt.subplots()
 
         # Plot raw data
@@ -614,7 +626,11 @@ def _is_treated(self, x):
         return np.greater_equal(x, self.treatment_threshold)
 
     def plot(self, round_to=None):
-        """Plot results"""
+        """Plot results
+
+        :param round_to:
+            Number of decimals used to round results. Defaults to 2. Use "none" to return raw numbers.
+        """
         fig, ax = plt.subplots()
         # Plot raw data
         sns.scatterplot(