added quantile probability plot as a method for hssm

lnccbrown · Dec 12, 2023 · da6f333 · da6f333
1 parent b7d51e8
commit da6f333
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/src/hssm/hssm.py b/src/hssm/hssm.py
@@ -496,6 +496,20 @@ def plot_posterior_predictive(self, **kwargs) -> mpl.axes.Axes | sns.FacetGrid:
         """
         return plotting.plot_posterior_predictive(self, **kwargs)
 
+    def plot_quantile_probability(self, **kwargs) -> mpl.axes.Axes | sns.FacetGrid:
+        """Produce a quantile probability plot.
+
+        Equivalent to calling `hssm.plotting.plot_quantile_probability()` with the
+        model. Please see that function for
+        [full documentation][hssm.plotting.plot_quantile_probability].
+
+        Returns
+        -------
+        mpl.axes.Axes | sns.FacetGrid
+            The matplotlib axis or seaborn FacetGrid object containing the plot.
+        """
+        return plotting.plot_quantile_probability(self, **kwargs)
+
     def sample_prior_predictive(
         self,
         draws: int = 500,