Added gap_width_percent to group_summary_kwargs so that users can specify the gapped line gap size

Author: JAnns98

dabest/_effsize_objects.py

@@ -1155,7 +1155,7 @@ def plot(
             command here, as a dict. This will change the appearance of the
             vertical summary lines for each group, if `group_summaries` is not
             'None'. If None, the following keywords are passed to
-            matplotlib.lines.Line2D : {'lw':2, 'alpha':1, 'zorder':3}.
+            matplotlib.lines.Line2D : {'lw':2, 'alpha':1, 'zorder':3, 'gap_width_percent':1.5}.
         legend_kwargs : dict, default None
             Pass any keyword arguments accepted by the matplotlib Axes
             `legend` command here, as a dict. If None, the following keywords

dabest/misc_tools.py

@@ -295,7 +295,8 @@ def get_kwargs(plot_kwargs, ytick_color):
     default_group_summary_kwargs = {
                         "zorder": 3, 
                         "lw": 2, 
-                        "alpha": 1
+                        "alpha": 1,
+                        'gap_width_percent': 1.5,
     }
     if plot_kwargs["group_summary_kwargs"] is None:
         group_summary_kwargs = default_group_summary_kwargs

dabest/plotter.py

@@ -45,11 +45,7 @@ def effectsize_df_plotter(effectsize_df, **plot_kwargs):
         fig_size=None,
         dpi=100,
         ax=None,
-
-
         gridkey_rows=None, gridkey_kwargs=None,
-
-
         swarmplot_kwargs=None,
         violinplot_kwargs=None,
         slopegraph_kwargs=None,
@@ -306,7 +302,6 @@ def effectsize_df_plotter(effectsize_df, **plot_kwargs):
                 y=yvar,
                 offset=group_summaries_offset,
                 line_color=group_summaries_line_color,
-                gap_width_percent=1.5,
                 type=group_summaries,
                 ax=rawdata_axes,
                 method=group_summaries_method,

nbs/API/effsize_objects.ipynb

@@ -1314,7 +1314,7 @@
     "            command here, as a dict. This will change the appearance of the\n",
     "            vertical summary lines for each group, if `group_summaries` is not\n",
     "            'None'. If None, the following keywords are passed to\n",
-    "            matplotlib.lines.Line2D : {'lw':2, 'alpha':1, 'zorder':3}.\n",
+    "            matplotlib.lines.Line2D : {'lw':2, 'alpha':1, 'zorder':3, 'gap_width_percent':1.5}.\n",
     "        legend_kwargs : dict, default None\n",
     "            Pass any keyword arguments accepted by the matplotlib Axes\n",
     "            `legend` command here, as a dict. If None, the following keywords\n",

nbs/API/misc_tools.ipynb

@@ -348,7 +348,8 @@
     "    default_group_summary_kwargs = {\n",
     "                        \"zorder\": 3, \n",
     "                        \"lw\": 2, \n",
-    "                        \"alpha\": 1\n",
+    "                        \"alpha\": 1,\n",
+    "                        'gap_width_percent': 1.5,\n",
     "    }\n",
     "    if plot_kwargs[\"group_summary_kwargs\"] is None:\n",
     "        group_summary_kwargs = default_group_summary_kwargs\n",

nbs/API/plotter.ipynb

@@ -102,11 +102,7 @@
     "        fig_size=None,\n",
     "        dpi=100,\n",
     "        ax=None,\n",
-    "\n",
-    "\n",
     "        gridkey_rows=None, gridkey_kwargs=None,\n",
-    "\n",
-    "\n",
     "        swarmplot_kwargs=None,\n",
     "        violinplot_kwargs=None,\n",
     "        slopegraph_kwargs=None,\n",
@@ -363,7 +359,6 @@
     "                y=yvar,\n",
     "                offset=group_summaries_offset,\n",
     "                line_color=group_summaries_line_color,\n",
-    "                gap_width_percent=1.5,\n",
     "                type=group_summaries,\n",
     "                ax=rawdata_axes,\n",
     "                method=group_summaries_method,\n",