Bug fix for custom palette dictionary in delta delta use case

Author: JAnns98

dabest/misc_tools.py

@@ -481,7 +481,8 @@ def get_color_palette(
         xvar: str, 
         show_pairs: bool, 
         idx: list, 
-        all_plot_groups: list
+        all_plot_groups: list,
+        delta2: bool,
     ):
     """
     Create the color palette to be used in the plotter function.
@@ -500,6 +501,8 @@ def get_color_palette(
         A list of tuples containing the group names.
     all_plot_groups : list
         A list of all the group names.
+    delta2 : bool
+        A boolean flag to determine if the plot will have a delta-delta effect size.
     """
     # Create color palette that will be shared across subplots.
     color_col = plot_kwargs["color_col"]
@@ -550,9 +553,16 @@ def get_color_palette(
             unsat_colors = [sns.color_palette("gray")[3]] + unsat_colors
     else:
         if isinstance(custom_pal, dict):
-            groups_in_palette = {
-                k: custom_pal[k] for k in all_plot_groups if k in color_groups
-            }
+            if delta2:
+                groups_in_palette = {
+                    k: custom_pal[k] for k in color_groups
+                }
+            elif color_col is None:
+                groups_in_palette = {
+                    k: custom_pal[k] for k in all_plot_groups if k in color_groups
+                }
+            else:
+                raise ValueError("The `custom_palette` dictionary is not supported when `color_col` is None.")
 
             names = groups_in_palette.keys()
             unsat_colors = groups_in_palette.values()

dabest/plotter.py

@@ -151,7 +151,8 @@ def effectsize_df_plotter(effectsize_df: object, **plot_kwargs) -> matplotlib.fi
                                                                                         xvar = xvar, 
                                                                                         show_pairs = show_pairs,
                                                                                         idx = idx,
-                                                                                        all_plot_groups = all_plot_groups
+                                                                                        all_plot_groups = all_plot_groups,
+                                                                                        delta2 = effectsize_df.delta2
                                                                                         )
 
     # Initialise the figure.

nbs/API/misc_tools.ipynb

@@ -534,7 +534,8 @@
     "        xvar: str, \n",
     "        show_pairs: bool, \n",
     "        idx: list, \n",
-    "        all_plot_groups: list\n",
+    "        all_plot_groups: list,\n",
+    "        delta2: bool,\n",
     "    ):\n",
     "    \"\"\"\n",
     "    Create the color palette to be used in the plotter function.\n",
@@ -553,6 +554,8 @@
     "        A list of tuples containing the group names.\n",
     "    all_plot_groups : list\n",
     "        A list of all the group names.\n",
+    "    delta2 : bool\n",
+    "        A boolean flag to determine if the plot will have a delta-delta effect size.\n",
     "    \"\"\"\n",
     "    # Create color palette that will be shared across subplots.\n",
     "    color_col = plot_kwargs[\"color_col\"]\n",
@@ -603,9 +606,16 @@
     "            unsat_colors = [sns.color_palette(\"gray\")[3]] + unsat_colors\n",
     "    else:\n",
     "        if isinstance(custom_pal, dict):\n",
-    "            groups_in_palette = {\n",
-    "                k: custom_pal[k] for k in all_plot_groups if k in color_groups\n",
-    "            }\n",
+    "            if delta2:\n",
+    "                groups_in_palette = {\n",
+    "                    k: custom_pal[k] for k in color_groups\n",
+    "                }\n",
+    "            elif color_col is None:\n",
+    "                groups_in_palette = {\n",
+    "                    k: custom_pal[k] for k in all_plot_groups if k in color_groups\n",
+    "                }\n",
+    "            else:\n",
+    "                raise ValueError(\"The `custom_palette` dictionary is not supported when `color_col` is None.\")\n",
     "\n",
     "            names = groups_in_palette.keys()\n",
     "            unsat_colors = groups_in_palette.values()\n",

nbs/API/plotter.ipynb

@@ -208,7 +208,8 @@
     "                                                                                        xvar = xvar, \n",
     "                                                                                        show_pairs = show_pairs,\n",
     "                                                                                        idx = idx,\n",
-    "                                                                                        all_plot_groups = all_plot_groups\n",
+    "                                                                                        all_plot_groups = all_plot_groups,\n",
+    "                                                                                        delta2 = effectsize_df.delta2\n",
     "                                                                                        )\n",
     "\n",
     "    # Initialise the figure.\n",