Bug fix for y-lim issues when deltadots are shown

Remove deltadots when the effect size is hedges_g/delta_g/cohens_h. Also remove duplicate variable (effect_size and effect_size_type)

Author: JAnns98

dabest/misc_tools.py

@@ -138,11 +138,11 @@ def get_params(
     # Disable Gardner-Altman plotting if any of the idxs comprise of more than
     # two groups or if it is a delta-delta plot.
     float_contrast = plot_kwargs["float_contrast"]
-    effect_size_type = effectsize_df.effect_size
+    # effect_size_type = effectsize_df.effect_size
     if len(idx) > 1 or len(idx[0]) > 2:
         float_contrast = False
 
-    if effect_size_type in ["cliffs_delta"]:
+    if effect_size in ["cliffs_delta"]:
         float_contrast = False
 
     if show_delta2 or show_mini_meta:
@@ -176,7 +176,7 @@ def get_params(
     show_baseline_ec = plot_kwargs["show_baseline_ec"]
 
     return (dabest_obj, plot_data, xvar, yvar, is_paired, effect_size, proportional, all_plot_groups, idx, 
-            show_delta2, show_mini_meta, float_contrast, show_pairs, effect_size_type, group_summaries, err_color, horizontal,
+            show_delta2, show_mini_meta, float_contrast, show_pairs, group_summaries, err_color, horizontal,
             results, halfviolin_alpha, ci_type, x1_level, experiment_label, show_baseline_ec)
 
 def get_kwargs(

dabest/plotter.py

@@ -118,11 +118,13 @@ def effectsize_df_plotter(effectsize_df: object, **plot_kwargs) -> matplotlib.fi
 
     # Extract parameters and set kwargs
     (dabest_obj, plot_data, xvar, yvar, is_paired, effect_size, proportional, all_plot_groups, idx, 
-    show_delta2, show_mini_meta, float_contrast, show_pairs, effect_size_type, group_summaries, err_color, horizontal,
+    show_delta2, show_mini_meta, float_contrast, show_pairs, group_summaries, err_color, horizontal,
     results, halfviolin_alpha, ci_type, x1_level, experiment_label, show_baseline_ec) = get_params(
      																							effectsize_df = effectsize_df, 
                                                                                                 plot_kwargs = plot_kwargs,
                                                                                                 )
+    
+    print(effect_size)
 
     (swarmplot_kwargs, barplot_kwargs, sankey_kwargs, 
      violinplot_kwargs, slopegraph_kwargs, reflines_kwargs, legend_kwargs,
@@ -166,7 +168,7 @@ def effectsize_df_plotter(effectsize_df: object, **plot_kwargs) -> matplotlib.fi
                                                             show_pairs = show_pairs, 
                                                             proportional = proportional, 
                                                             float_contrast = float_contrast,
-                                                            effect_size_type = effect_size_type,
+                                                            effect_size_type = effect_size,
                                                             yvar = yvar,
                                                             horizontal = horizontal,
                                                             show_table = table_kwargs['show']
@@ -198,7 +200,8 @@ def effectsize_df_plotter(effectsize_df: object, **plot_kwargs) -> matplotlib.fi
 
             # Add delta dots to the contrast axes for paired plots.
             show_delta_dots = plot_kwargs["delta_dot"]
-            if show_delta_dots and is_paired is not None:
+            unavailable_effect_sizes = ["hedges_g", "delta_g", "cohens_d"]
+            if show_delta_dots and is_paired and not any([es in effect_size for es in unavailable_effect_sizes]):
                 DeltaDotsPlotter(
                     plot_data = plot_data, 
                     contrast_axes = contrast_axes, 
@@ -424,7 +427,7 @@ def effectsize_df_plotter(effectsize_df: object, **plot_kwargs) -> matplotlib.fi
     if float_contrast and not horizontal:
         # For Gardner-Altman plots only.
         Gardner_Altman_Plot_Aesthetic_Adjustments(
-                                            effect_size_type = effect_size_type, 
+                                            effect_size_type = effect_size, 
                                             plot_data = plot_data, 
                                             xvar = xvar, 
                                             yvar = yvar, 

nbs/API/misc_tools.ipynb

@@ -191,11 +191,11 @@
     "    # Disable Gardner-Altman plotting if any of the idxs comprise of more than\n",
     "    # two groups or if it is a delta-delta plot.\n",
     "    float_contrast = plot_kwargs[\"float_contrast\"]\n",
-    "    effect_size_type = effectsize_df.effect_size\n",
+    "    # effect_size_type = effectsize_df.effect_size\n",
     "    if len(idx) > 1 or len(idx[0]) > 2:\n",
     "        float_contrast = False\n",
     "\n",
-    "    if effect_size_type in [\"cliffs_delta\"]:\n",
+    "    if effect_size in [\"cliffs_delta\"]:\n",
     "        float_contrast = False\n",
     "\n",
     "    if show_delta2 or show_mini_meta:\n",
@@ -229,7 +229,7 @@
     "    show_baseline_ec = plot_kwargs[\"show_baseline_ec\"]\n",
     "        \n",
     "    return (dabest_obj, plot_data, xvar, yvar, is_paired, effect_size, proportional, all_plot_groups, idx, \n",
-    "            show_delta2, show_mini_meta, float_contrast, show_pairs, effect_size_type, group_summaries, err_color, horizontal,\n",
+    "            show_delta2, show_mini_meta, float_contrast, show_pairs, group_summaries, err_color, horizontal,\n",
     "            results, halfviolin_alpha, ci_type, x1_level, experiment_label, show_baseline_ec)\n",
     "\n",
     "def get_kwargs(\n",

nbs/API/plotter.ipynb

@@ -175,11 +175,13 @@
     "\n",
     "    # Extract parameters and set kwargs\n",
     "    (dabest_obj, plot_data, xvar, yvar, is_paired, effect_size, proportional, all_plot_groups, idx, \n",
-    "    show_delta2, show_mini_meta, float_contrast, show_pairs, effect_size_type, group_summaries, err_color, horizontal,\n",
+    "    show_delta2, show_mini_meta, float_contrast, show_pairs, group_summaries, err_color, horizontal,\n",
     "    results, halfviolin_alpha, ci_type, x1_level, experiment_label, show_baseline_ec) = get_params(\n",
     "     \t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\teffectsize_df = effectsize_df, \n",
     "                                                                                                plot_kwargs = plot_kwargs,\n",
     "                                                                                                )\n",
+    "    \n",
+    "    print(effect_size)\n",
     "\n",
     "    (swarmplot_kwargs, barplot_kwargs, sankey_kwargs, \n",
     "     violinplot_kwargs, slopegraph_kwargs, reflines_kwargs, legend_kwargs,\n",
@@ -223,7 +225,7 @@
     "                                                            show_pairs = show_pairs, \n",
     "                                                            proportional = proportional, \n",
     "                                                            float_contrast = float_contrast,\n",
-    "                                                            effect_size_type = effect_size_type,\n",
+    "                                                            effect_size_type = effect_size,\n",
     "                                                            yvar = yvar,\n",
     "                                                            horizontal = horizontal,\n",
     "                                                            show_table = table_kwargs['show']\n",
@@ -255,7 +257,8 @@
     "            \n",
     "            # Add delta dots to the contrast axes for paired plots.\n",
     "            show_delta_dots = plot_kwargs[\"delta_dot\"]\n",
-    "            if show_delta_dots and is_paired is not None:\n",
+    "            unavailable_effect_sizes = [\"hedges_g\", \"delta_g\", \"cohens_d\"]\n",
+    "            if show_delta_dots and is_paired and not any([es in effect_size for es in unavailable_effect_sizes]):\n",
     "                DeltaDotsPlotter(\n",
     "                    plot_data = plot_data, \n",
     "                    contrast_axes = contrast_axes, \n",
@@ -481,7 +484,7 @@
     "    if float_contrast and not horizontal:\n",
     "        # For Gardner-Altman plots only.\n",
     "        Gardner_Altman_Plot_Aesthetic_Adjustments(\n",
-    "                                            effect_size_type = effect_size_type, \n",
+    "                                            effect_size_type = effect_size, \n",
     "                                            plot_data = plot_data, \n",
     "                                            xvar = xvar, \n",
     "                                            yvar = yvar, \n",