Skip to content

Commit b6a02f0

Browse files
Jacobluke-Jacobluke-
committed
Fixed some docstring issues
1 parent 97585d1 commit b6a02f0

4 files changed

Lines changed: 43 additions & 77 deletions

File tree

‎dabest/plotter.py‎

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -17,42 +17,6 @@
1717
def effectsize_df_plotter(effectsize_df, **plot_kwargs):
1818
"""
1919
Custom function that creates an estimation plot from an EffectSizeDataFrame.
20-
Keywords
21-
--------
22-
Parameters
23-
----------
24-
effectsize_df
25-
A `dabest` EffectSizeDataFrame object.
26-
plot_kwargs
27-
color_col=None
28-
raw_marker_size=6, es_marker_size=9,
29-
swarm_label=None, contrast_label=None, delta2_label=None,
30-
swarm_ylim=None, contrast_ylim=None, delta2_ylim=None,
31-
custom_palette=None, swarm_desat=0.5, halfviolin_desat=1,
32-
halfviolin_alpha=0.8,
33-
face_color = None,
34-
bar_label=None, bar_desat=0.8, bar_width = 0.5,bar_ylim = None,
35-
ci=None, ci_type='bca', err_color=None,
36-
float_contrast=True,
37-
show_pairs=True,
38-
show_delta2=True,
39-
group_summaries=None,
40-
group_summaries_offset=0.1,
41-
fig_size=None,
42-
dpi=100,
43-
ax=None,
44-
gridkey_rows=None,
45-
swarmplot_kwargs=None,
46-
violinplot_kwargs=None,
47-
slopegraph_kwargs=None,
48-
sankey_kwargs=None,
49-
reflines_kwargs=None,
50-
group_summary_kwargs=None,
51-
legend_kwargs=None,
52-
title=None, fontsize_title=16,
53-
fontsize_rawxlabel=12, fontsize_rawylabel=12,
54-
fontsize_contrastxlabel=12, fontsize_contrastylabel=12,
55-
fontsize_delta2label=12
5620
"""
5721
from .misc_tools import merge_two_dicts
5822
from .plot_tools import (

‎nbs/API/plotter.ipynb‎

Lines changed: 41 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -76,42 +76,6 @@
7676
"def effectsize_df_plotter(effectsize_df, **plot_kwargs):\n",
7777
" \"\"\"\n",
7878
" Custom function that creates an estimation plot from an EffectSizeDataFrame.\n",
79-
" Keywords\n",
80-
" --------\n",
81-
" Parameters\n",
82-
" ----------\n",
83-
" effectsize_df\n",
84-
" A `dabest` EffectSizeDataFrame object.\n",
85-
" plot_kwargs\n",
86-
" color_col=None\n",
87-
" raw_marker_size=6, es_marker_size=9,\n",
88-
" swarm_label=None, contrast_label=None, delta2_label=None,\n",
89-
" swarm_ylim=None, contrast_ylim=None, delta2_ylim=None,\n",
90-
" custom_palette=None, swarm_desat=0.5, halfviolin_desat=1,\n",
91-
" halfviolin_alpha=0.8,\n",
92-
" face_color = None,\n",
93-
" bar_label=None, bar_desat=0.8, bar_width = 0.5,bar_ylim = None,\n",
94-
" ci=None, ci_type='bca', err_color=None,\n",
95-
" float_contrast=True,\n",
96-
" show_pairs=True,\n",
97-
" show_delta2=True,\n",
98-
" group_summaries=None,\n",
99-
" group_summaries_offset=0.1,\n",
100-
" fig_size=None,\n",
101-
" dpi=100,\n",
102-
" ax=None,\n",
103-
" gridkey_rows=None,\n",
104-
" swarmplot_kwargs=None,\n",
105-
" violinplot_kwargs=None,\n",
106-
" slopegraph_kwargs=None,\n",
107-
" sankey_kwargs=None,\n",
108-
" reflines_kwargs=None,\n",
109-
" group_summary_kwargs=None,\n",
110-
" legend_kwargs=None,\n",
111-
" title=None, fontsize_title=16,\n",
112-
" fontsize_rawxlabel=12, fontsize_rawylabel=12,\n",
113-
" fontsize_contrastxlabel=12, fontsize_contrastylabel=12,\n",
114-
" fontsize_delta2label=12\n",
11579
" \"\"\"\n",
11680
" from .misc_tools import merge_two_dicts\n",
11781
" from .plot_tools import (\n",
@@ -1665,11 +1629,49 @@
16651629
]
16661630
},
16671631
{
1668-
"cell_type": "code",
1669-
"execution_count": null,
1632+
"cell_type": "markdown",
16701633
"id": "7355251f",
16711634
"metadata": {},
1672-
"outputs": [],
1635+
"source": [
1636+
"For details on how to control the aesthetic of the generated estimation plot by modifying the **plot_kwargs**, please refer to [Controlling Plot Aesthetics](../tutorials/06-plot_aesthetics.ipynb)\n",
1637+
"\n",
1638+
"- **effectsize_df**: A `dabest` `EffectSizeDataFrame` object.\n",
1639+
"- **plot_kwargs**:\n",
1640+
" - color_col=None\n",
1641+
" - raw_marker_size=6, es_marker_size=9,\n",
1642+
" - swarm_label=None, contrast_label=None, delta2_label=None,\n",
1643+
" - swarm_ylim=None, contrast_ylim=None, delta2_ylim=None,\n",
1644+
" - custom_palette=None, swarm_desat=0.5, halfviolin_desat=1,\n",
1645+
" - halfviolin_alpha=0.8,\n",
1646+
" - face_color = None,\n",
1647+
" - bar_label=None, bar_desat=0.8, bar_width = 0.5,bar_ylim = None,\n",
1648+
" - ci=None, ci_type='bca', err_color=None,\n",
1649+
" - float_contrast=True,\n",
1650+
" - show_pairs=True,\n",
1651+
" - show_delta2=True,\n",
1652+
" - group_summaries=None,\n",
1653+
" - group_summaries_offset=0.1,\n",
1654+
" - fig_size=None,\n",
1655+
" - dpi=100,\n",
1656+
" - ax=None,\n",
1657+
" - gridkey_rows=None,\n",
1658+
" - swarmplot_kwargs=None,\n",
1659+
" - violinplot_kwargs=None,\n",
1660+
" - slopegraph_kwargs=None,\n",
1661+
" - sankey_kwargs=None,\n",
1662+
" - reflines_kwargs=None,\n",
1663+
" - group_summary_kwargs=None,\n",
1664+
" - egend_kwargs=None,\n",
1665+
" - title=None, fontsize_title=16,\n",
1666+
" - fontsize_rawxlabel=12, fontsize_rawylabel=12,\n",
1667+
" - fontsize_contrastxlabel=12, fontsize_contrastylabel=12,\n",
1668+
" - fontsize_delta2label=12"
1669+
]
1670+
},
1671+
{
1672+
"cell_type": "markdown",
1673+
"id": "f1cc27d4",
1674+
"metadata": {},
16731675
"source": []
16741676
}
16751677
],

‎nbs/tutorials/03-proportion_plot.ipynb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -452,7 +452,7 @@
452452
"To generate a proportion plot, the **dabest** library features two effect sizes:\n",
453453
"\n",
454454
" - the mean difference (``mean_diff``)\n",
455-
" - [Cohen's h](https://en.wikipedia.org/wiki/Cohen%27s_h) (``cohens_h``)\n",
455+
" - [Cohen's h](https://en.wikipedia.org/wiki/Cohen's_h) (`cohens＿h`)\n",
456456
"\n",
457457
"These are attributes of the ``Dabest`` object."
458458
]

‎nbs/tutorials/04-mini_meta_delta.ipynb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
"\n",
4848
"Additionally, be aware that as of v2023.02.14, DABEST can only compute weighted effect size *for mean difference only*, and not for standardized measures such as Cohen's *d*.\n",
4949
"\n",
50-
"For more information on meta-analysis, please refer to Chapter 10 of the Cochrane handbook: https://training.cochrane.org/handbook/current/chapter-10\n"
50+
"For more information on meta-analysis, please refer to [Chapter 10 of the Cochrane handbook](https://training.cochrane.org/handbook/current/chapter-10)"
5151
]
5252
},
5353
{

0 commit comments

Comments
 (0)