Add pointer to example in docstring

hyosubkim · Apr 20, 2023 · 104c688 · 104c688
1 parent 318904a
commit 104c688
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/bayes_toolbox/meta.py b/bayes_toolbox/meta.py
@@ -38,6 +38,8 @@
 def meta_binary_outcome(z_t_obs, n_t_obs, z_c_obs, n_c_obs, study, n_draws=1000):
     """Fits multi-level meta-analysis model of binary outcomes.
     
+    See "meta-analysis-two-proportions.ipynb" in examples for usage.
+    
     Args:
         z_t_obs: number of occurrences in treatment group
         n_t_obs: number of opportunities/participants in treatment gruops