diff --git a/dabest/_api.py b/dabest/_api.py index 7c8d0eac..a6399385 100644 --- a/dabest/_api.py +++ b/dabest/_api.py @@ -1,3 +1,5 @@ +"""Loading data and relevant groups""" + # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/API/load.ipynb. # %% auto 0 diff --git a/dabest/_dabest_object.py b/dabest/_dabest_object.py index 94980e3e..d61245dd 100644 --- a/dabest/_dabest_object.py +++ b/dabest/_dabest_object.py @@ -1,3 +1,5 @@ +"""Main class for estimating statistics and generating plots.""" + # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/API/dabest_object.ipynb. # %% auto 0 diff --git a/dabest/_delta_objects.py b/dabest/_delta_objects.py index 30c44895..1827c1b2 100644 --- a/dabest/_delta_objects.py +++ b/dabest/_delta_objects.py @@ -1,3 +1,5 @@ +"""Auxiliary delta classes for estimating statistics and generating plots.""" + # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/API/delta_objects.ipynb. # %% auto 0 diff --git a/dabest/_effsize_objects.py b/dabest/_effsize_objects.py index 99ea373f..fe11222f 100644 --- a/dabest/_effsize_objects.py +++ b/dabest/_effsize_objects.py @@ -1,3 +1,5 @@ +"""The auxiliary classes involved in the computations of bootstrapped effect sizes.""" + # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/API/effsize_objects.ipynb. # %% auto 0 diff --git a/dabest/_stats_tools/confint_1group.py b/dabest/_stats_tools/confint_1group.py index a9b0beb1..744a7142 100644 --- a/dabest/_stats_tools/confint_1group.py +++ b/dabest/_stats_tools/confint_1group.py @@ -1,3 +1,5 @@ +"""A range of functions to compute bootstraps for a single sample.""" + # AUTOGENERATED! DO NOT EDIT! File to edit: ../../nbs/API/confint_1group.ipynb. # %% auto 0 diff --git a/dabest/_stats_tools/confint_2group_diff.py b/dabest/_stats_tools/confint_2group_diff.py index 3b07eb96..c599e178 100644 --- a/dabest/_stats_tools/confint_2group_diff.py +++ b/dabest/_stats_tools/confint_2group_diff.py @@ -1,3 +1,5 @@ +"""A range of functions to compute bootstraps for the mean difference""" + # AUTOGENERATED! DO NOT EDIT! File to edit: ../../nbs/API/confint_2group_diff.ipynb. # %% auto 0 diff --git a/dabest/_stats_tools/effsize.py b/dabest/_stats_tools/effsize.py index bb941389..402745cc 100644 --- a/dabest/_stats_tools/effsize.py +++ b/dabest/_stats_tools/effsize.py @@ -1,3 +1,5 @@ +"""A range of functions to compute various effect sizes.""" + # AUTOGENERATED! DO NOT EDIT! File to edit: ../../nbs/API/effsize.ipynb. # %% ../../nbs/API/effsize.ipynb 4 diff --git a/dabest/forest_plot.py b/dabest/forest_plot.py index 852f0a2e..f87ffe7f 100644 --- a/dabest/forest_plot.py +++ b/dabest/forest_plot.py @@ -1,3 +1,5 @@ +"""Creating forest plots from contrast objects.""" + # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/API/forest_plot.ipynb. # %% auto 0 diff --git a/dabest/misc_tools.py b/dabest/misc_tools.py index a3936102..151d01d3 100644 --- a/dabest/misc_tools.py +++ b/dabest/misc_tools.py @@ -1,3 +1,5 @@ +"""Convenience functions that don't directly deal with plotting or bootstrap computations are placed here.""" + # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/API/misc_tools.ipynb. # %% auto 0 diff --git a/dabest/plot_tools.py b/dabest/plot_tools.py index dd6e157d..c43cbe7d 100644 --- a/dabest/plot_tools.py +++ b/dabest/plot_tools.py @@ -1,3 +1,5 @@ +"""A set of convenience functions used for producing plots in `dabest`.""" + # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/API/plot_tools.ipynb. # %% ../nbs/API/plot_tools.ipynb 2 diff --git a/dabest/plotter.py b/dabest/plotter.py index 3b314431..bf98b507 100644 --- a/dabest/plotter.py +++ b/dabest/plotter.py @@ -1,3 +1,5 @@ +"""Creating estimation plots.""" + # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/API/plotter.ipynb. # %% auto 0 diff --git a/nbs/API/plotter.ipynb b/nbs/API/plotter.ipynb index d428cb69..0be53949 100644 --- a/nbs/API/plotter.ipynb +++ b/nbs/API/plotter.ipynb @@ -730,10 +730,6 @@ "display_name": "python3", "language": "python", "name": "python3" - }, - "language_info": { - "name": "python", - "version": "3.11.8" } }, "nbformat": 4,