diff --git a/dabest/plotter.py b/dabest/plotter.py index fcd65ee5..f0a72f85 100644 --- a/dabest/plotter.py +++ b/dabest/plotter.py @@ -17,42 +17,6 @@ def effectsize_df_plotter(effectsize_df, **plot_kwargs): """ Custom function that creates an estimation plot from an EffectSizeDataFrame. - Keywords - -------- - Parameters - ---------- - effectsize_df - A `dabest` EffectSizeDataFrame object. - plot_kwargs - color_col=None - raw_marker_size=6, es_marker_size=9, - swarm_label=None, contrast_label=None, delta2_label=None, - swarm_ylim=None, contrast_ylim=None, delta2_ylim=None, - custom_palette=None, swarm_desat=0.5, halfviolin_desat=1, - halfviolin_alpha=0.8, - face_color = None, - bar_label=None, bar_desat=0.8, bar_width = 0.5,bar_ylim = None, - ci=None, ci_type='bca', err_color=None, - float_contrast=True, - show_pairs=True, - show_delta2=True, - group_summaries=None, - group_summaries_offset=0.1, - fig_size=None, - dpi=100, - ax=None, - gridkey_rows=None, - swarmplot_kwargs=None, - violinplot_kwargs=None, - slopegraph_kwargs=None, - sankey_kwargs=None, - reflines_kwargs=None, - group_summary_kwargs=None, - legend_kwargs=None, - title=None, fontsize_title=16, - fontsize_rawxlabel=12, fontsize_rawylabel=12, - fontsize_contrastxlabel=12, fontsize_contrastylabel=12, - fontsize_delta2label=12 """ from .misc_tools import merge_two_dicts from .plot_tools import ( diff --git a/nbs/API/plotter.ipynb b/nbs/API/plotter.ipynb index 7e054ea4..c120d9b6 100644 --- a/nbs/API/plotter.ipynb +++ b/nbs/API/plotter.ipynb @@ -76,42 +76,6 @@ "def effectsize_df_plotter(effectsize_df, **plot_kwargs):\n", " \"\"\"\n", " Custom function that creates an estimation plot from an EffectSizeDataFrame.\n", - " Keywords\n", - " --------\n", - " Parameters\n", - " ----------\n", - " effectsize_df\n", - " A `dabest` EffectSizeDataFrame object.\n", - " plot_kwargs\n", - " color_col=None\n", - " raw_marker_size=6, es_marker_size=9,\n", - " swarm_label=None, contrast_label=None, delta2_label=None,\n", - " swarm_ylim=None, contrast_ylim=None, delta2_ylim=None,\n", - " custom_palette=None, swarm_desat=0.5, halfviolin_desat=1,\n", - " halfviolin_alpha=0.8,\n", - " face_color = None,\n", - " bar_label=None, bar_desat=0.8, bar_width = 0.5,bar_ylim = None,\n", - " ci=None, ci_type='bca', err_color=None,\n", - " float_contrast=True,\n", - " show_pairs=True,\n", - " show_delta2=True,\n", - " group_summaries=None,\n", - " group_summaries_offset=0.1,\n", - " fig_size=None,\n", - " dpi=100,\n", - " ax=None,\n", - " gridkey_rows=None,\n", - " swarmplot_kwargs=None,\n", - " violinplot_kwargs=None,\n", - " slopegraph_kwargs=None,\n", - " sankey_kwargs=None,\n", - " reflines_kwargs=None,\n", - " group_summary_kwargs=None,\n", - " legend_kwargs=None,\n", - " title=None, fontsize_title=16,\n", - " fontsize_rawxlabel=12, fontsize_rawylabel=12,\n", - " fontsize_contrastxlabel=12, fontsize_contrastylabel=12,\n", - " fontsize_delta2label=12\n", " \"\"\"\n", " from .misc_tools import merge_two_dicts\n", " from .plot_tools import (\n", @@ -1665,11 +1629,49 @@ ] }, { - "cell_type": "code", - "execution_count": null, + "cell_type": "markdown", "id": "7355251f", "metadata": {}, - "outputs": [], + "source": [ + "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", + "\n", + "- **effectsize_df**: A `dabest` `EffectSizeDataFrame` object.\n", + "- **plot_kwargs**:\n", + " - color_col=None\n", + " - raw_marker_size=6, es_marker_size=9,\n", + " - swarm_label=None, contrast_label=None, delta2_label=None,\n", + " - swarm_ylim=None, contrast_ylim=None, delta2_ylim=None,\n", + " - custom_palette=None, swarm_desat=0.5, halfviolin_desat=1,\n", + " - halfviolin_alpha=0.8,\n", + " - face_color = None,\n", + " - bar_label=None, bar_desat=0.8, bar_width = 0.5,bar_ylim = None,\n", + " - ci=None, ci_type='bca', err_color=None,\n", + " - float_contrast=True,\n", + " - show_pairs=True,\n", + " - show_delta2=True,\n", + " - group_summaries=None,\n", + " - group_summaries_offset=0.1,\n", + " - fig_size=None,\n", + " - dpi=100,\n", + " - ax=None,\n", + " - gridkey_rows=None,\n", + " - swarmplot_kwargs=None,\n", + " - violinplot_kwargs=None,\n", + " - slopegraph_kwargs=None,\n", + " - sankey_kwargs=None,\n", + " - reflines_kwargs=None,\n", + " - group_summary_kwargs=None,\n", + " - egend_kwargs=None,\n", + " - title=None, fontsize_title=16,\n", + " - fontsize_rawxlabel=12, fontsize_rawylabel=12,\n", + " - fontsize_contrastxlabel=12, fontsize_contrastylabel=12,\n", + " - fontsize_delta2label=12" + ] + }, + { + "cell_type": "markdown", + "id": "f1cc27d4", + "metadata": {}, "source": [] } ], diff --git a/nbs/tutorials/03-proportion_plot.ipynb b/nbs/tutorials/03-proportion_plot.ipynb index 3ec2f34e..ffaa1ccb 100644 --- a/nbs/tutorials/03-proportion_plot.ipynb +++ b/nbs/tutorials/03-proportion_plot.ipynb @@ -452,7 +452,7 @@ "To generate a proportion plot, the **dabest** library features two effect sizes:\n", "\n", " - the mean difference (``mean_diff``)\n", - " - [Cohen's h](https://en.wikipedia.org/wiki/Cohen%27s_h) (``cohens_h``)\n", + " - [Cohen's h](https://en.wikipedia.org/wiki/Cohen's_h) (`cohens＿h`)\n", "\n", "These are attributes of the ``Dabest`` object." ] diff --git a/nbs/tutorials/04-mini_meta_delta.ipynb b/nbs/tutorials/04-mini_meta_delta.ipynb index 595432d9..dcac4a8e 100644 --- a/nbs/tutorials/04-mini_meta_delta.ipynb +++ b/nbs/tutorials/04-mini_meta_delta.ipynb @@ -47,7 +47,7 @@ "\n", "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", "\n", - "For more information on meta-analysis, please refer to Chapter 10 of the Cochrane handbook: https://training.cochrane.org/handbook/current/chapter-10\n" + "For more information on meta-analysis, please refer to [Chapter 10 of the Cochrane handbook](https://training.cochrane.org/handbook/current/chapter-10)" ] }, {