Added a kwarg to horizontal plots to hide the table ax

Author: JAnns98

dabest/_effsize_objects.py

@@ -1217,8 +1217,8 @@ def plot(
             Whether or not to plot the effect size plot in a horizontal format.
         horizontal_table_kwargs : dict, default None
             Pass relevant keyword arguments to the horizontal table. If None, the following keywords are passed:
-            {'color' : 'yellow', 'alpha' :0.2, 'fontsize' : 12, 'text_color' : 'black', 'text_units' : None, 
-            'paired_gap_dashes' : False, 'fontsize_label': 12, 'label': 'Δ'}
+            {'show: True, 'color' : 'yellow', 'alpha' :0.2, 'fontsize' : 12, 'text_color' : 'black', 
+            'text_units' : None, 'paired_gap_dashes' : False, 'fontsize_label': 12, 'label': 'Δ'}
             
         gridkey_rows : list, default None
             Provide a list of row labels for the gridkey. The supplied idx is

dabest/misc_tools.py

@@ -379,6 +379,7 @@ def get_kwargs(plot_kwargs, ytick_color):
 
     # Table axes for horizontal plot kwargs.
     default_table_kwargs = {
+                'show': True,
                 'color' : 'yellow',
                 'alpha' :0.2,
                 'fontsize' : 12,
@@ -571,7 +572,7 @@ def get_color_palette(plot_kwargs, plot_data, xvar, show_pairs, idx, all_plot_gr
             plot_palette_bar, plot_palette_contrast, plot_palette_sankey)
 
 def initialize_fig(plot_kwargs, dabest_obj, show_delta2, show_mini_meta, is_paired, show_pairs, proportional,
-                   float_contrast, effect_size_type, yvar, horizontal):
+                   float_contrast, effect_size_type, yvar, horizontal, show_table):
     """
     Initialize the figure and axes for the plotter function.
 
@@ -599,8 +600,8 @@ def initialize_fig(plot_kwargs, dabest_obj, show_delta2, show_mini_meta, is_pair
         The name of the y-axis variable.
     horizontal : bool
         A boolean flag to determine if the plot is for horizontal plotting.
-    redraw_axes_kwargs : dict
-        Kwargs for the redraw_axes.
+    show_table : dict
+        A boolean flag to determine if the table will be shown in horizontal plot.
     """
     # Params
     fig_size = plot_kwargs["fig_size"]
@@ -655,9 +656,12 @@ def initialize_fig(plot_kwargs, dabest_obj, show_delta2, show_mini_meta, is_pair
             contrast_axes = rawdata_axes.inset_axes(
                     [1+contrast_wspace, 0, (plot_width_ratios[1]/plot_width_ratios[0]), 1]
                     )
-            table_axes = rawdata_axes.inset_axes(
-                    [1+contrast_wspace+(plot_width_ratios[1]/plot_width_ratios[0]), 0, (plot_width_ratios[2]/plot_width_ratios[0]), 1]
-                    )
+            if show_table:
+                table_axes = rawdata_axes.inset_axes(
+                        [1+contrast_wspace+(plot_width_ratios[1]/plot_width_ratios[0]), 0, (plot_width_ratios[2]/plot_width_ratios[0]), 1]
+                        )
+            else:
+                table_axes = None
 
             rawdata_axes.set_position(
                     [ax_position.x0,
@@ -703,25 +707,26 @@ def initialize_fig(plot_kwargs, dabest_obj, show_delta2, show_mini_meta, is_pair
     else:
         # Here, we hardcode some figure parameters.
         if horizontal:
-            fig, axx = plt.subplots(
-                ncols=3, gridspec_kw={'width_ratios' : [1,0.7,0.3], 'wspace' : 0.05}, **init_fig_kwargs
-            )
-            fig.patch.set_facecolor(face_color)
-
+            if show_table:
+                fig, axx = plt.subplots(
+                    ncols=3, gridspec_kw={'width_ratios' : [1,0.7,0.3], 'wspace' : 0.05}, **init_fig_kwargs
+                )
+            else:
+                fig, axx = plt.subplots(
+                    ncols=2, gridspec_kw={'width_ratios' : [1,0.7], 'wspace' : 0.05}, **init_fig_kwargs
+                )
         else:
             if float_contrast:
                 fig, axx = plt.subplots(
                     ncols=2,
                     gridspec_kw={"width_ratios": width_ratios_ga, "wspace": 0},
                     **init_fig_kwargs
                 )
-                fig.patch.set_facecolor(face_color)
-
             else:
                 fig, axx = plt.subplots(
                     nrows=2, gridspec_kw={"hspace": h_space_cummings}, **init_fig_kwargs
                 )
-                fig.patch.set_facecolor(face_color)
+        fig.patch.set_facecolor(face_color)
 
         # Title
         title = plot_kwargs["title"]
@@ -730,10 +735,10 @@ def initialize_fig(plot_kwargs, dabest_obj, show_delta2, show_mini_meta, is_pair
             fig.suptitle(title, fontsize=fontsize_title)
         rawdata_axes = axx[0]
         contrast_axes = axx[1]
-        table_axes = axx[2] if horizontal else None
+        table_axes = axx[2] if horizontal and show_table else None
     rawdata_axes.set_frame_on(False)
     contrast_axes.set_frame_on(False)
-    if horizontal:
+    if horizontal and show_table:
         table_axes.set_frame_on(False)
 
     # Swarmplot ylim (Vertical) or xlim (Horizontal)

dabest/plotter.py

@@ -163,6 +163,7 @@ def effectsize_df_plotter(effectsize_df, **plot_kwargs):
                                                             effect_size_type=effect_size_type,
                                                             yvar=yvar,
                                                             horizontal=horizontal,
+                                                            show_table = table_kwargs['show']
                                                             )
 
     # Plotting the rawdata.
@@ -537,7 +538,7 @@ def effectsize_df_plotter(effectsize_df, **plot_kwargs):
                     )
 
     # Table Axes for horizontal plots
-    if horizontal:
+    if horizontal and table_kwargs['show']:
         table_for_horizontal_plots(
                             effectsize_df = effectsize_df,
                             ax = table_axes,

nbs/API/effsize_objects.ipynb

@@ -1376,8 +1376,8 @@
     "            Whether or not to plot the effect size plot in a horizontal format.\n",
     "        horizontal_table_kwargs : dict, default None\n",
     "            Pass relevant keyword arguments to the horizontal table. If None, the following keywords are passed:\n",
-    "            {'color' : 'yellow', 'alpha' :0.2, 'fontsize' : 12, 'text_color' : 'black', 'text_units' : None, \n",
-    "            'paired_gap_dashes' : False, 'fontsize_label': 12, 'label': 'Δ'}\n",
+    "            {'show: True, 'color' : 'yellow', 'alpha' :0.2, 'fontsize' : 12, 'text_color' : 'black', \n",
+    "            'text_units' : None, 'paired_gap_dashes' : False, 'fontsize_label': 12, 'label': 'Δ'}\n",
     "            \n",
     "        gridkey_rows : list, default None\n",
     "            Provide a list of row labels for the gridkey. The supplied idx is\n",

nbs/API/misc_tools.ipynb

@@ -432,6 +432,7 @@
     "\n",
     "    # Table axes for horizontal plot kwargs.\n",
     "    default_table_kwargs = {\n",
+    "                'show': True,\n",
     "                'color' : 'yellow',\n",
     "                'alpha' :0.2,\n",
     "                'fontsize' : 12,\n",
@@ -624,7 +625,7 @@
     "            plot_palette_bar, plot_palette_contrast, plot_palette_sankey)\n",
     "\n",
     "def initialize_fig(plot_kwargs, dabest_obj, show_delta2, show_mini_meta, is_paired, show_pairs, proportional,\n",
-    "                   float_contrast, effect_size_type, yvar, horizontal):\n",
+    "                   float_contrast, effect_size_type, yvar, horizontal, show_table):\n",
     "    \"\"\"\n",
     "    Initialize the figure and axes for the plotter function.\n",
     "\n",
@@ -652,8 +653,8 @@
     "        The name of the y-axis variable.\n",
     "    horizontal : bool\n",
     "        A boolean flag to determine if the plot is for horizontal plotting.\n",
-    "    redraw_axes_kwargs : dict\n",
-    "        Kwargs for the redraw_axes.\n",
+    "    show_table : dict\n",
+    "        A boolean flag to determine if the table will be shown in horizontal plot.\n",
     "    \"\"\"\n",
     "    # Params\n",
     "    fig_size = plot_kwargs[\"fig_size\"]\n",
@@ -708,9 +709,12 @@
     "            contrast_axes = rawdata_axes.inset_axes(\n",
     "                    [1+contrast_wspace, 0, (plot_width_ratios[1]/plot_width_ratios[0]), 1]\n",
     "                    )\n",
-    "            table_axes = rawdata_axes.inset_axes(\n",
-    "                    [1+contrast_wspace+(plot_width_ratios[1]/plot_width_ratios[0]), 0, (plot_width_ratios[2]/plot_width_ratios[0]), 1]\n",
-    "                    )\n",
+    "            if show_table:\n",
+    "                table_axes = rawdata_axes.inset_axes(\n",
+    "                        [1+contrast_wspace+(plot_width_ratios[1]/plot_width_ratios[0]), 0, (plot_width_ratios[2]/plot_width_ratios[0]), 1]\n",
+    "                        )\n",
+    "            else:\n",
+    "                table_axes = None\n",
     "\n",
     "            rawdata_axes.set_position(\n",
     "                    [ax_position.x0,\n",
@@ -756,25 +760,26 @@
     "    else:\n",
     "        # Here, we hardcode some figure parameters.\n",
     "        if horizontal:\n",
-    "            fig, axx = plt.subplots(\n",
-    "                ncols=3, gridspec_kw={'width_ratios' : [1,0.7,0.3], 'wspace' : 0.05}, **init_fig_kwargs\n",
-    "            )\n",
-    "            fig.patch.set_facecolor(face_color)\n",
-    "\n",
+    "            if show_table:\n",
+    "                fig, axx = plt.subplots(\n",
+    "                    ncols=3, gridspec_kw={'width_ratios' : [1,0.7,0.3], 'wspace' : 0.05}, **init_fig_kwargs\n",
+    "                )\n",
+    "            else:\n",
+    "                fig, axx = plt.subplots(\n",
+    "                    ncols=2, gridspec_kw={'width_ratios' : [1,0.7], 'wspace' : 0.05}, **init_fig_kwargs\n",
+    "                )\n",
     "        else:\n",
     "            if float_contrast:\n",
     "                fig, axx = plt.subplots(\n",
     "                    ncols=2,\n",
     "                    gridspec_kw={\"width_ratios\": width_ratios_ga, \"wspace\": 0},\n",
     "                    **init_fig_kwargs\n",
     "                )\n",
-    "                fig.patch.set_facecolor(face_color)\n",
-    "\n",
     "            else:\n",
     "                fig, axx = plt.subplots(\n",
     "                    nrows=2, gridspec_kw={\"hspace\": h_space_cummings}, **init_fig_kwargs\n",
     "                )\n",
-    "                fig.patch.set_facecolor(face_color)\n",
+    "        fig.patch.set_facecolor(face_color)\n",
     "\n",
     "        # Title\n",
     "        title = plot_kwargs[\"title\"]\n",
@@ -783,10 +788,10 @@
     "            fig.suptitle(title, fontsize=fontsize_title)\n",
     "        rawdata_axes = axx[0]\n",
     "        contrast_axes = axx[1]\n",
-    "        table_axes = axx[2] if horizontal else None\n",
+    "        table_axes = axx[2] if horizontal and show_table else None\n",
     "    rawdata_axes.set_frame_on(False)\n",
     "    contrast_axes.set_frame_on(False)\n",
-    "    if horizontal:\n",
+    "    if horizontal and show_table:\n",
     "        table_axes.set_frame_on(False)\n",
     "    \n",
     "    # Swarmplot ylim (Vertical) or xlim (Horizontal)\n",

nbs/API/plotter.ipynb

@@ -220,6 +220,7 @@
     "                                                            effect_size_type=effect_size_type,\n",
     "                                                            yvar=yvar,\n",
     "                                                            horizontal=horizontal,\n",
+    "                                                            show_table = table_kwargs['show']\n",
     "                                                            )\n",
     "    \n",
     "    # Plotting the rawdata.\n",
@@ -594,7 +595,7 @@
     "                    )\n",
     "\n",
     "    # Table Axes for horizontal plots\n",
-    "    if horizontal:\n",
+    "    if horizontal and table_kwargs['show']:\n",
     "        table_for_horizontal_plots(\n",
     "                            effectsize_df = effectsize_df,\n",
     "                            ax = table_axes,\n",

nbs/tests/mpl_image_tests/baseline_images/test_415_Horizontal_Table_hide.png

@@ -826,3 +826,7 @@ def test_413_gridkey_merge_pairs_and_autoparser():
 def test_414_gridkey_kwargs_and_autoparser():
     return two_groups_unpaired.mean_diff.plot(horizontal=True, gridkey_rows='auto', gridkey_kwargs=gridkey_kwargs);
 
+# Table hide
+@pytest.mark.mpl_image_compare(tolerance=8)
+def test_415_Horizontal_Table_hide():
+    return multi_2group_unpaired.mean_diff.plot(horizontal=True, horizontal_table_kwargs={'show': False});