Merge pull request #222 from ACCLAB/patch-prop-plot-bse-docs

Patch prop plot bse docs

Author: sangyu

dabest/_api.py

@@ -1,4 +1,6 @@
-"""Loading data and relevant groups"""
+"""Loading data and relevant groups
+
+Docs: https://acclab.github.io/DABEST-python/API/load.html.md"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/API/load.ipynb.
 

dabest/_bootstrap_tools.py

@@ -1,3 +1,5 @@
+"""Docs: https://acclab.github.io/DABEST-python/API/bootstrap.html.md"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/API/bootstrap.ipynb.
 
 # %% auto #0

dabest/_dabest_object.py

@@ -1,4 +1,6 @@
-"""Main class for estimating statistics and generating plots."""
+"""Main class for estimating statistics and generating plots.
+
+Docs: https://acclab.github.io/DABEST-python/API/dabest_object.html.md"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/API/dabest_object.ipynb.
 

dabest/_delta_objects.py

@@ -1,4 +1,6 @@
-"""Auxiliary delta classes for estimating statistics and generating plots."""
+"""Auxiliary delta classes for estimating statistics and generating plots.
+
+Docs: https://acclab.github.io/DABEST-python/API/delta_objects.html.md"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/API/delta_objects.ipynb.
 

dabest/_effsize_objects.py

@@ -1,4 +1,6 @@
-"""The auxiliary classes involved in the computations of bootstrapped effect sizes."""
+"""The auxiliary classes involved in the computations of bootstrapped effect sizes.
+
+Docs: https://acclab.github.io/DABEST-python/API/effsize_objects.html.md"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/API/effsize_objects.ipynb.
 
@@ -1304,7 +1306,7 @@ def plot(
         group_summaries : ['mean_sd', 'median_quartiles', 'None'], default "mean_sd".
             Plots the summary statistics for each group. If 'mean_sd', then
             the mean and standard deviation of each group is plotted as a
-            notched line beside each group. If 'median_quantiles', then the
+            notched line beside each group. For proportion and Sankey plots, this error is the binomial standard error (BSE), sqrt(p(1-p)/n), not the SD. If 'median_quantiles', then the
             median and 25th and 75th percentiles of each group is plotted
             instead. If 'None', the summaries are not shown.
         fig_size : tuple, default None

dabest/_stats_tools/confint_1group.py

@@ -1,4 +1,6 @@
-"""A range of functions to compute bootstraps for a single sample."""
+"""A range of functions to compute bootstraps for a single sample.
+
+Docs: https://acclab.github.io/DABEST-python/API/confint_1group.html.md"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../../nbs/API/confint_1group.ipynb.
 

dabest/_stats_tools/confint_2group_diff.py

@@ -1,4 +1,6 @@
-"""A range of functions to compute bootstraps for the mean difference"""
+"""A range of functions to compute bootstraps for the mean difference
+
+Docs: https://acclab.github.io/DABEST-python/API/confint_2group_diff.html.md"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../../nbs/API/confint_2group_diff.ipynb.
 

dabest/_stats_tools/effsize.py

@@ -1,4 +1,6 @@
-"""A range of functions to compute various effect sizes."""
+"""A range of functions to compute various effect sizes.
+
+Docs: https://acclab.github.io/DABEST-python/API/effsize.html.md"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../../nbs/API/effsize.ipynb.
 

dabest/_stats_tools/precompile.py

@@ -1,4 +1,6 @@
-"""A tool to pre-compile Numba functions for speeding up DABEST bootstrapping"""
+"""A tool to pre-compile Numba functions for speeding up DABEST bootstrapping
+
+Docs: https://acclab.github.io/DABEST-python/API/precompile.html.md"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../../nbs/API/precompile.ipynb.
 

dabest/forest_plot.py

@@ -1,4 +1,6 @@
-"""Creating forest plots from contrast objects."""
+"""Creating forest plots from contrast objects.
+
+Docs: https://acclab.github.io/DABEST-python/API/forest_plot.html.md"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/API/forest_plot.ipynb.