Add gap to contrast axes zeroline for delta-delta experiments and fix contrast axes xlim bug for delta g

Author: JAnns98

dabest/misc_tools.py

@@ -1227,7 +1227,15 @@ def set_xaxis_ticks_and_lims(
 
         if float_contrast:
             contrast_axes.set_xlim(0.5, 1.5)
-        elif show_delta2 or show_mini_meta:
+
+        if show_delta2:
+            if show_pairs:
+                rawdata_axes.set_xlim(-0.375, 5.5)
+            else:
+                rawdata_axes.set_xlim(-0.5, 5.5)
+            contrast_axes.set_xlim(rawdata_axes.get_xlim())
+
+        elif show_mini_meta:
             # Increase the xlim of raw data by 2
             temp = rawdata_axes.get_xlim()
             if show_pairs:
@@ -1529,19 +1537,33 @@ def gardner_altman_adjustments(
 def draw_zeroline(
         ax : axes.Axes,
         horizontal : bool,
-        reflines_kwargs : dict
+        reflines_kwargs : dict,
+        extra_delta : bool,
     ):
     # If 0 lies within the ylim of the contrast axes, draw a zero reference line.
-    ax_lim = ax.get_xlim() if horizontal else ax.get_ylim()
-    method = ax.axvline if horizontal else ax.axhline
+    if extra_delta and not horizontal:
+        contrast_xlim = [-0.5, 3.5]
+        delta2_xlim = [4, 5.5]
+        
+        if ax.get_ylim()[0] < ax.get_ylim()[1]:
+            contrast_lim_low, contrast_lim_high = ax.get_ylim()
+        else:
+            contrast_lim_high, contrast_lim_low = ax.get_ylim()
 
-    if ax_lim[0] < ax_lim[1]:
-        contrast_lim_low, contrast_lim_high = ax_lim
+        if contrast_lim_low < 0 < contrast_lim_high:
+            ax.hlines(y=0, xmin=contrast_xlim[0], xmax=contrast_xlim[1], **reflines_kwargs)
+            ax.hlines(y=0, xmin=delta2_xlim[0], xmax=delta2_xlim[1], **reflines_kwargs)
     else:
-        contrast_lim_high, contrast_lim_low = ax_lim
+        ax_lim = ax.get_xlim() if horizontal else ax.get_ylim()
+        method = ax.axvline if horizontal else ax.axhline
+
+        if ax_lim[0] < ax_lim[1]:
+            contrast_lim_low, contrast_lim_high = ax_lim
+        else:
+            contrast_lim_high, contrast_lim_low = ax_lim
 
-    if contrast_lim_low < 0 < contrast_lim_high:
-        method(0, **reflines_kwargs)
+        if contrast_lim_low < 0 < contrast_lim_high:
+            method(0, **reflines_kwargs)
 
 def redraw_independent_spines(
         rawdata_axes : axes.Axes,

dabest/plotter.py

@@ -394,7 +394,6 @@ def effectsize_df_plotter(effectsize_df: object, **plot_kwargs) -> matplotlib.fi
                                                                 es_marker_kwargs = es_marker_kwargs,
                                                                 es_errorbar_kwargs = es_errorbar_kwargs
         )
-
     ## Contrast bars
     contrast_bars = plot_kwargs["contrast_bars"]
     if contrast_bars:
@@ -452,7 +451,6 @@ def effectsize_df_plotter(effectsize_df: object, **plot_kwargs) -> matplotlib.fi
                     proportional = proportional,
                     horizontal = horizontal,
     )
-
     # Plot aesthetic adjustments.
     if float_contrast: # For Gardner-Altman (float contrast) plots only.
         gardner_altman_adjustments(
@@ -476,7 +474,8 @@ def effectsize_df_plotter(effectsize_df: object, **plot_kwargs) -> matplotlib.fi
         draw_zeroline(
                 ax = contrast_axes,
                 horizontal = horizontal,
-                reflines_kwargs = reflines_kwargs
+                reflines_kwargs = reflines_kwargs,
+                extra_delta = True if show_delta2 else False,
         )
         ## Axes independent spine lines
         is_gridkey = True if plot_kwargs["gridkey_rows"] is not None else False

nbs/API/misc_tools.ipynb

@@ -1281,7 +1281,15 @@
     "\n",
     "        if float_contrast:\n",
     "            contrast_axes.set_xlim(0.5, 1.5)\n",
-    "        elif show_delta2 or show_mini_meta:\n",
+    "\n",
+    "        if show_delta2:\n",
+    "            if show_pairs:\n",
+    "                rawdata_axes.set_xlim(-0.375, 5.5)\n",
+    "            else:\n",
+    "                rawdata_axes.set_xlim(-0.5, 5.5)\n",
+    "            contrast_axes.set_xlim(rawdata_axes.get_xlim())\n",
+    "\n",
+    "        elif show_mini_meta:\n",
     "            # Increase the xlim of raw data by 2\n",
     "            temp = rawdata_axes.get_xlim()\n",
     "            if show_pairs:\n",
@@ -1583,19 +1591,33 @@
     "def draw_zeroline(\n",
     "        ax : axes.Axes,\n",
     "        horizontal : bool,\n",
-    "        reflines_kwargs : dict\n",
+    "        reflines_kwargs : dict,\n",
+    "        extra_delta : bool,\n",
     "    ):\n",
     "    # If 0 lies within the ylim of the contrast axes, draw a zero reference line.\n",
-    "    ax_lim = ax.get_xlim() if horizontal else ax.get_ylim()\n",
-    "    method = ax.axvline if horizontal else ax.axhline\n",
+    "    if extra_delta and not horizontal:\n",
+    "        contrast_xlim = [-0.5, 3.5]\n",
+    "        delta2_xlim = [4, 5.5]\n",
+    "        \n",
+    "        if ax.get_ylim()[0] < ax.get_ylim()[1]:\n",
+    "            contrast_lim_low, contrast_lim_high = ax.get_ylim()\n",
+    "        else:\n",
+    "            contrast_lim_high, contrast_lim_low = ax.get_ylim()\n",
     "\n",
-    "    if ax_lim[0] < ax_lim[1]:\n",
-    "        contrast_lim_low, contrast_lim_high = ax_lim\n",
+    "        if contrast_lim_low < 0 < contrast_lim_high:\n",
+    "            ax.hlines(y=0, xmin=contrast_xlim[0], xmax=contrast_xlim[1], **reflines_kwargs)\n",
+    "            ax.hlines(y=0, xmin=delta2_xlim[0], xmax=delta2_xlim[1], **reflines_kwargs)\n",
     "    else:\n",
-    "        contrast_lim_high, contrast_lim_low = ax_lim\n",
+    "        ax_lim = ax.get_xlim() if horizontal else ax.get_ylim()\n",
+    "        method = ax.axvline if horizontal else ax.axhline\n",
+    "\n",
+    "        if ax_lim[0] < ax_lim[1]:\n",
+    "            contrast_lim_low, contrast_lim_high = ax_lim\n",
+    "        else:\n",
+    "            contrast_lim_high, contrast_lim_low = ax_lim\n",
     "\n",
-    "    if contrast_lim_low < 0 < contrast_lim_high:\n",
-    "        method(0, **reflines_kwargs)\n",
+    "        if contrast_lim_low < 0 < contrast_lim_high:\n",
+    "            method(0, **reflines_kwargs)\n",
     "\n",
     "def redraw_independent_spines(\n",
     "        rawdata_axes : axes.Axes,\n",

nbs/API/plotter.ipynb

@@ -451,7 +451,6 @@
     "                                                                es_marker_kwargs = es_marker_kwargs,\n",
     "                                                                es_errorbar_kwargs = es_errorbar_kwargs\n",
     "        )\n",
-    "\n",
     "    ## Contrast bars\n",
     "    contrast_bars = plot_kwargs[\"contrast_bars\"]\n",
     "    if contrast_bars:\n",
@@ -509,7 +508,6 @@
     "                    proportional = proportional,\n",
     "                    horizontal = horizontal,\n",
     "    )\n",
-    "\n",
     "    # Plot aesthetic adjustments.\n",
     "    if float_contrast: # For Gardner-Altman (float contrast) plots only.\n",
     "        gardner_altman_adjustments(\n",
@@ -533,7 +531,8 @@
     "        draw_zeroline(\n",
     "                ax = contrast_axes,\n",
     "                horizontal = horizontal,\n",
-    "                reflines_kwargs = reflines_kwargs\n",
+    "                reflines_kwargs = reflines_kwargs,\n",
+    "                extra_delta = True if show_delta2 else False,\n",
     "        )\n",
     "        ## Axes independent spine lines\n",
     "        is_gridkey = True if plot_kwargs[\"gridkey_rows\"] is not None else False\n",