Skip to content

Commit dbb62c3

Browse files
committed
feat: update api, tutorial, and tests
1 parent 1fdbd49 commit dbb62c3

8 files changed

Lines changed: 314 additions & 170 deletions

File tree

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
# DABEST-Python
22

3-
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
3+
4+
[![minimal Python
5+
version](https://img.shields.io/badge/Python%3E%3D-3.6-6666ff.svg)](https://www.anaconda.com/distribution/)
6+
[![PyPI
7+
version](https://badge.fury.io/py/dabest.svg)](https://badge.fury.io/py/dabest)
8+
[![Downloads](https://pepy.tech/badge/dabest/month.png)](https://pepy.tech/project/dabest/month)
9+
[![Free-to-view
10+
citation](https://zenodo.org/badge/DOI/10.1038/s41592-019-0470-3.svg)](https://rdcu.be/bHhJ4)
11+
[![License](https://img.shields.io/badge/License-BSD%203--Clause--Clear-orange.svg)](https://spdx.org/licenses/BSD-3-Clause-Clear.html)
412

513
## Recent Version Update
614

dabest/_modidx.py

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -17,31 +17,31 @@
1717
'dabest/_stats_tools/confint_1group.py'),
1818
'dabest._stats_tools.confint_1group.summary_ci_1group': ( 'API/confint_1group.html#summary_ci_1group',
1919
'dabest/_stats_tools/confint_1group.py')},
20-
'dabest._stats_tools.confint_2group_diff': { 'dabest._stats_tools.confint_2group_diff._calc_accel': ( 'API/confint_2group_diff.html#_calc_accel',
20+
'dabest._stats_tools.confint_2group_diff': { 'dabest._stats_tools.confint_2group_diff._calc_accel': ( 'API/confint_diff.html#_calc_accel',
2121
'dabest/_stats_tools/confint_2group_diff.py'),
22-
'dabest._stats_tools.confint_2group_diff._compute_alpha_from_ci': ( 'API/confint_2group_diff.html#_compute_alpha_from_ci',
22+
'dabest._stats_tools.confint_2group_diff._compute_alpha_from_ci': ( 'API/confint_diff.html#_compute_alpha_from_ci',
2323
'dabest/_stats_tools/confint_2group_diff.py'),
24-
'dabest._stats_tools.confint_2group_diff._compute_quantile': ( 'API/confint_2group_diff.html#_compute_quantile',
24+
'dabest._stats_tools.confint_2group_diff._compute_quantile': ( 'API/confint_diff.html#_compute_quantile',
2525
'dabest/_stats_tools/confint_2group_diff.py'),
26-
'dabest._stats_tools.confint_2group_diff._create_two_group_jackknife_indexes': ( 'API/confint_2group_diff.html#_create_two_group_jackknife_indexes',
26+
'dabest._stats_tools.confint_2group_diff._create_two_group_jackknife_indexes': ( 'API/confint_diff.html#_create_two_group_jackknife_indexes',
2727
'dabest/_stats_tools/confint_2group_diff.py'),
28-
'dabest._stats_tools.confint_2group_diff.calculate_group_var': ( 'API/confint_2group_diff.html#calculate_group_var',
28+
'dabest._stats_tools.confint_2group_diff.calculate_group_var': ( 'API/confint_diff.html#calculate_group_var',
2929
'dabest/_stats_tools/confint_2group_diff.py'),
30-
'dabest._stats_tools.confint_2group_diff.calculate_weighted_delta': ( 'API/confint_2group_diff.html#calculate_weighted_delta',
30+
'dabest._stats_tools.confint_2group_diff.calculate_weighted_delta': ( 'API/confint_diff.html#calculate_weighted_delta',
3131
'dabest/_stats_tools/confint_2group_diff.py'),
32-
'dabest._stats_tools.confint_2group_diff.compute_bootstrapped_diff': ( 'API/confint_2group_diff.html#compute_bootstrapped_diff',
32+
'dabest._stats_tools.confint_2group_diff.compute_bootstrapped_diff': ( 'API/confint_diff.html#compute_bootstrapped_diff',
3333
'dabest/_stats_tools/confint_2group_diff.py'),
34-
'dabest._stats_tools.confint_2group_diff.compute_delta2_bootstrapped_diff': ( 'API/confint_2group_diff.html#compute_delta2_bootstrapped_diff',
34+
'dabest._stats_tools.confint_2group_diff.compute_delta2_bootstrapped_diff': ( 'API/confint_diff.html#compute_delta2_bootstrapped_diff',
3535
'dabest/_stats_tools/confint_2group_diff.py'),
36-
'dabest._stats_tools.confint_2group_diff.compute_interval_limits': ( 'API/confint_2group_diff.html#compute_interval_limits',
36+
'dabest._stats_tools.confint_2group_diff.compute_interval_limits': ( 'API/confint_diff.html#compute_interval_limits',
3737
'dabest/_stats_tools/confint_2group_diff.py'),
38-
'dabest._stats_tools.confint_2group_diff.compute_meandiff_bias_correction': ( 'API/confint_2group_diff.html#compute_meandiff_bias_correction',
38+
'dabest._stats_tools.confint_2group_diff.compute_meandiff_bias_correction': ( 'API/confint_diff.html#compute_meandiff_bias_correction',
3939
'dabest/_stats_tools/confint_2group_diff.py'),
40-
'dabest._stats_tools.confint_2group_diff.compute_meandiff_jackknife': ( 'API/confint_2group_diff.html#compute_meandiff_jackknife',
40+
'dabest._stats_tools.confint_2group_diff.compute_meandiff_jackknife': ( 'API/confint_diff.html#compute_meandiff_jackknife',
4141
'dabest/_stats_tools/confint_2group_diff.py'),
42-
'dabest._stats_tools.confint_2group_diff.create_jackknife_indexes': ( 'API/confint_2group_diff.html#create_jackknife_indexes',
42+
'dabest._stats_tools.confint_2group_diff.create_jackknife_indexes': ( 'API/confint_diff.html#create_jackknife_indexes',
4343
'dabest/_stats_tools/confint_2group_diff.py'),
44-
'dabest._stats_tools.confint_2group_diff.create_repeated_indexes': ( 'API/confint_2group_diff.html#create_repeated_indexes',
44+
'dabest._stats_tools.confint_2group_diff.create_repeated_indexes': ( 'API/confint_diff.html#create_repeated_indexes',
4545
'dabest/_stats_tools/confint_2group_diff.py')},
4646
'dabest._stats_tools.effsize': { 'dabest._stats_tools.effsize._compute_hedges_correction_factor': ( 'API/effsize.html#_compute_hedges_correction_factor',
4747
'dabest/_stats_tools/effsize.py'),
@@ -64,24 +64,25 @@
6464
'dabest.forest_plot': { 'dabest.forest_plot.extract_plot_data': ( 'API/forest_plot.html#extract_plot_data',
6565
'dabest/forest_plot.py'),
6666
'dabest.forest_plot.forest_plot': ('API/forest_plot.html#forest_plot', 'dabest/forest_plot.py'),
67-
'dabest.forest_plot.load_plot_data': ('API/forest_plot.html#load_plot_data', 'dabest/forest_plot.py')},
67+
'dabest.forest_plot.load_plot_data': ('API/forest_plot.html#load_plot_data', 'dabest/forest_plot.py'),
68+
'dabest.forest_plot.map_effect_attribute': ( 'API/forest_plot.html#map_effect_attribute',
69+
'dabest/forest_plot.py')},
6870
'dabest.misc_tools': { 'dabest.misc_tools.get_varname': ('API/misc_tools.html#get_varname', 'dabest/misc_tools.py'),
6971
'dabest.misc_tools.merge_two_dicts': ('API/misc_tools.html#merge_two_dicts', 'dabest/misc_tools.py'),
7072
'dabest.misc_tools.print_greeting': ('API/misc_tools.html#print_greeting', 'dabest/misc_tools.py'),
7173
'dabest.misc_tools.unpack_and_add': ('API/misc_tools.html#unpack_and_add', 'dabest/misc_tools.py')},
7274
'dabest.plot_tools': { 'dabest.plot_tools.SwarmPlot': ('API/plot_tools.html#swarmplot', 'dabest/plot_tools.py'),
73-
'dabest.plot_tools.SwarmPlot.__init__': ( 'API/plot_tools.html#swarmplot.__init__',
74-
'dabest/plot_tools.py'),
75-
'dabest.plot_tools.SwarmPlot._adjust_gutter_points': ( 'API/plot_tools.html#swarmplot._adjust_gutter_points',
75+
'dabest.plot_tools.SwarmPlot.__init__': ('API/plot_tools.html#__init__', 'dabest/plot_tools.py'),
76+
'dabest.plot_tools.SwarmPlot._adjust_gutter_points': ( 'API/plot_tools.html#_adjust_gutter_points',
7677
'dabest/plot_tools.py'),
77-
'dabest.plot_tools.SwarmPlot._check_errors': ( 'API/plot_tools.html#swarmplot._check_errors',
78+
'dabest.plot_tools.SwarmPlot._check_errors': ( 'API/plot_tools.html#_check_errors',
7879
'dabest/plot_tools.py'),
79-
'dabest.plot_tools.SwarmPlot._format_palette': ( 'API/plot_tools.html#swarmplot._format_palette',
80+
'dabest.plot_tools.SwarmPlot._format_palette': ( 'API/plot_tools.html#_format_palette',
8081
'dabest/plot_tools.py'),
81-
'dabest.plot_tools.SwarmPlot._generate_order': ( 'API/plot_tools.html#swarmplot._generate_order',
82+
'dabest.plot_tools.SwarmPlot._generate_order': ( 'API/plot_tools.html#_generate_order',
8283
'dabest/plot_tools.py'),
83-
'dabest.plot_tools.SwarmPlot._swarm': ('API/plot_tools.html#swarmplot._swarm', 'dabest/plot_tools.py'),
84-
'dabest.plot_tools.SwarmPlot.plot': ('API/plot_tools.html#swarmplot.plot', 'dabest/plot_tools.py'),
84+
'dabest.plot_tools.SwarmPlot._swarm': ('API/plot_tools.html#_swarm', 'dabest/plot_tools.py'),
85+
'dabest.plot_tools.SwarmPlot.plot': ('API/plot_tools.html#plot', 'dabest/plot_tools.py'),
8586
'dabest.plot_tools.check_data_matches_labels': ( 'API/plot_tools.html#check_data_matches_labels',
8687
'dabest/plot_tools.py'),
8788
'dabest.plot_tools.error_bar': ('API/plot_tools.html#error_bar', 'dabest/plot_tools.py'),
@@ -92,4 +93,4 @@
9293
'dabest.plot_tools.single_sankey': ('API/plot_tools.html#single_sankey', 'dabest/plot_tools.py'),
9394
'dabest.plot_tools.swarmplot': ('API/plot_tools.html#swarmplot', 'dabest/plot_tools.py'),
9495
'dabest.plot_tools.width_determine': ('API/plot_tools.html#width_determine', 'dabest/plot_tools.py')},
95-
'dabest.plotter': {'dabest.plotter.effectsize_df_plotter': ('API/plotter.html#effectsize_df_plotter', 'dabest/plotter.py')}}}
96+
'dabest.plotter': {'dabest.plotter.effectsize_df_plotter': ('API/plotter.html#effectsize_df_plotter', 'dabest/plotter.py')}}}

0 commit comments

Comments
 (0)