Plot

Creating estimation plots.

---

source

effectsize_df_plotter

 effectsize_df_plotter (effectsize_df:object, **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, contrast_marker_kwargs=9, raw_label=None, contrast_label=None, delta2_label=None, raw_ylim=None, contrast_ylim=None, delta2_ylim=None, custom_palette=None, swarm_side=None, empty_circle=False, face_color=None, raw_desat=0.5, contrast_desat=1, raw_alpha=None, contrast_alpha=0.8, bar_width = 0.5, ci_type=‘bca’, float_contrast=True, show_pairs=True, show_sample_size=True, show_delta2=True, show_mini_meta=True, group_summaries=“mean_sd”, fig_size=None, dpi=100, ax=None, swarmplot_kwargs=None, slopegraph_kwargs=None, barplot_kwargs=None, sankey_kwargs=None, contrast_kwargs=None, reflines_kwargs=None, group_summaries_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,

raw_bars=True, raw_bars_kwargs=None, contrast_bars=True, contrast_bars_kwargs=None, reference_band=None, reference_band_kwargs=None, delta_text=True, delta_text_kwargs=None, delta_dot=True, delta_dot_kwargs=None,

horizontal=False, horizontal_table_kwargs=None, gridkey=None, gridkey_merge_pairs=False, gridkey_show_Ns=True, gridkey_show_es=True, gridkey_delimiters=[‘;’, ‘>’, ’_’], gridkey_kwargs=None, contrast_marker_kwargs=None, contrast_errorbar_kwargs=None, prop_sample_counts=False, prop_sample_counts_kwargs=None, contrast_paired_lines=True, contrast_paired_lines show_baseline_ec=False,*

For details on how to control the aesthetic of the generated estimation plot by modifying the plot_kwargs, please refer to Controlling Plot Aesthetics

• effectsize_df: A dabest EffectSizeDataFrame object.
• plot_kwargs:

  • color_col=None

  • raw_marker_size=6, contrast_marker_size=9,

  • raw_label=None, contrast_label=None, delta2_label=None,

  • raw_ylim=None, contrast_ylim=None, delta2_ylim=None,

  • custom_palette=None, swarm_side=None, empty_circle=False,

  • face_color = None,

  • raw_desat=0.5, contrast_desat=1,

  • raw_alpha=None, contrast_alpha=0.8,

  • bar_width=0.5,

  • ci_type=‘bca’,

  • float_contrast=True,

  • show_pairs=True,

  • show_sample_size=True

  • show_delta2=True, show_mini_meta=True,

  • group_summaries=“mean_sd”,

  • fig_size=None, dpi=100,

  • ax=None,

  • swarmplot_kwargs=None,

  • slopegraph_kwargs=None,

  • barplot_kwargs=None,

  • sankey_kwargs=None,

  • contrast_kwargs=None,

  • reflines_kwargs=None,

  • group_summaries_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,

  • raw_bars=True, raw_bars_kwargs=None,

  • contrast_bars=True, contrast_bars_kwargs=None,

  • reference_band=None, reference_band_kwargs=None,

  • delta_text=True, delta_text_kwargs=None,

  • delta_dot=True, delta_dot_kwargs=None,

  • horizontal=False, horizontal_table_kwargs=None,

  • gridkey=None, gridkey_merge_pairs=False,

  • gridkey_show_Ns=True, gridkey_show_es=True,

  • gridkey_delimiters=[‘;’, ‘>’, ’_’],

  • gridkey_kwargs=None,

  • contrast_marker_kwargs=None, contrast_errorbar_kwargs=None

  • prop_sample_counts=False, prop_sample_counts_kwargs=None

  • contrast_paired_lines=True, contrast_paired_lines_kwargs=None,

  • show_baseline_ec=False