Add custom_palette option for coloring barplots with 0 and 1 keys

now custom_palette dictionary can accept 0 and 1 to fill barplots

Author: JAnns98

dabest/misc_tools.py

@@ -516,7 +516,7 @@ def get_color_palette(
         idx: list, 
         all_plot_groups: list,
         delta2: bool,
-        sankey: bool
+        proportional: bool
     ):
     """
     Create the color palette to be used in the plotter function.
@@ -537,9 +537,11 @@ def get_color_palette(
         A list of all the group names.
     delta2 : bool
         A boolean flag to determine if the plot will have a delta-delta effect size.
-    sankey : bool
-        A boolean flag to determine if the plot is for a Sankey diagram.
+    proportional : bool
+        A boolean flag to determine if the plot is for a proportional plot.
     """
+    sankey = True if proportional and show_pairs else False
+
     # Create color palette that will be shared across subplots.
     color_col = plot_kwargs["color_col"]
     if color_col is None:
@@ -608,6 +610,17 @@ def get_color_palette(
                 groups_in_palette = {
                     k: custom_pal[k] for k in color_groups
                 }
+            elif proportional and not sankey: # barplots (unpaired proportional data)
+                keys = list(custom_pal.keys())
+                if all(k in keys for k in [1, 0]) and len(keys) == 2:
+                    groups_in_palette = {
+                        k: custom_pal[k] for k in [1, 0]
+                    }
+                    bootstraps_color_by_group = False
+                else:
+                    groups_in_palette = {
+                        k: custom_pal[k] for k in all_plot_groups if k in color_groups
+                    }
             elif sankey:
                 groups_in_palette = {
                     k: custom_pal[k] for k in [1, 0]

dabest/plot_tools.py

@@ -1885,6 +1885,9 @@ def barplotter(
     horizontal : bool
         If the plot is horizontal.
     """
+    # Check if the custom_palette is a dictionary with two keys 0 and 1 (for filled bar coloring)
+    filled_bars = True if len(plot_palette_raw.keys())==2 and all(k in plot_palette_raw for k in [1, 0]) else False
+
     bar_width = barplot_kwargs.get('width', 0.5)
     fontsize = barplot_kwargs.pop('fontsize')
 
@@ -1912,7 +1915,7 @@ def barplotter(
             for hue_val in bar1_df[color_col]
         ]
     else:
-        edge_colors = raw_colors
+        edge_colors = len(all_plot_groups)*['black',] if filled_bars else raw_colors
 
     bar1 = sns.barplot(
         data=bar1_df,
@@ -1921,20 +1924,26 @@ def barplotter(
         ax=rawdata_axes,
         order=all_plot_groups,
         linewidth=2,
-        facecolor=(1, 1, 1, 0),
+        facecolor=plot_palette_raw[0] if filled_bars else (1, 1, 1, 0),
         edgecolor=edge_colors,
         zorder=1,
         orient=orient,
     )
 
+    if filled_bars:
+        barplot_kwargs['facecolor'] = plot_palette_raw[1]
+        barplot_kwargs['edgecolor'] = 'black'
+        barplot_kwargs['linewidth'] = 2
+    else:
+        barplot_kwargs['palette'] = plot_palette_raw
+
     bar2 = sns.barplot(
         data=plot_data,
         x=yvar if horizontal else xvar,
         y=xvar if horizontal else yvar,
         hue=xvar if color_col is None else color_col,
         ax=rawdata_axes,
         order=all_plot_groups,
-        palette=plot_palette_raw,
         dodge=False,
         zorder=1,
         orient=orient,

dabest/plotter.py

@@ -161,7 +161,7 @@ def effectsize_df_plotter(effectsize_df: object, **plot_kwargs) -> matplotlib.fi
                                                                                 idx = idx,
                                                                                 all_plot_groups = all_plot_groups,
                                                                                 delta2 = effectsize_df.delta2,
-                                                                                sankey = True if proportional and show_pairs else False,
+                                                                                proportional = proportional
     )
 
     # Initialise the figure.

nbs/API/misc_tools.ipynb

@@ -569,7 +569,7 @@
     "        idx: list, \n",
     "        all_plot_groups: list,\n",
     "        delta2: bool,\n",
-    "        sankey: bool\n",
+    "        proportional: bool\n",
     "    ):\n",
     "    \"\"\"\n",
     "    Create the color palette to be used in the plotter function.\n",
@@ -590,9 +590,11 @@
     "        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",
-    "    sankey : bool\n",
-    "        A boolean flag to determine if the plot is for a Sankey diagram.\n",
+    "    proportional : bool\n",
+    "        A boolean flag to determine if the plot is for a proportional plot.\n",
     "    \"\"\"\n",
+    "    sankey = True if proportional and show_pairs else False\n",
+    "\n",
     "    # Create color palette that will be shared across subplots.\n",
     "    color_col = plot_kwargs[\"color_col\"]\n",
     "    if color_col is None:\n",
@@ -661,6 +663,17 @@
     "                groups_in_palette = {\n",
     "                    k: custom_pal[k] for k in color_groups\n",
     "                }\n",
+    "            elif proportional and not sankey: # barplots (unpaired proportional data)\n",
+    "                keys = list(custom_pal.keys())\n",
+    "                if all(k in keys for k in [1, 0]) and len(keys) == 2:\n",
+    "                    groups_in_palette = {\n",
+    "                        k: custom_pal[k] for k in [1, 0]\n",
+    "                    }\n",
+    "                    bootstraps_color_by_group = False\n",
+    "                else:\n",
+    "                    groups_in_palette = {\n",
+    "                        k: custom_pal[k] for k in all_plot_groups if k in color_groups\n",
+    "                    }\n",
     "            elif sankey:\n",
     "                groups_in_palette = {\n",
     "                    k: custom_pal[k] for k in [1, 0]\n",

nbs/API/plot_tools.ipynb

@@ -1936,6 +1936,9 @@
     "    horizontal : bool\n",
     "        If the plot is horizontal.\n",
     "    \"\"\"\n",
+    "    # Check if the custom_palette is a dictionary with two keys 0 and 1 (for filled bar coloring)\n",
+    "    filled_bars = True if len(plot_palette_raw.keys())==2 and all(k in plot_palette_raw for k in [1, 0]) else False\n",
+    "\n",
     "    bar_width = barplot_kwargs.get('width', 0.5)\n",
     "    fontsize = barplot_kwargs.pop('fontsize')\n",
     "\n",
@@ -1963,7 +1966,7 @@
     "            for hue_val in bar1_df[color_col]\n",
     "        ]\n",
     "    else:\n",
-    "        edge_colors = raw_colors\n",
+    "        edge_colors = len(all_plot_groups)*['black',] if filled_bars else raw_colors\n",
     "\n",
     "    bar1 = sns.barplot(\n",
     "        data=bar1_df,\n",
@@ -1972,20 +1975,26 @@
     "        ax=rawdata_axes,\n",
     "        order=all_plot_groups,\n",
     "        linewidth=2,\n",
-    "        facecolor=(1, 1, 1, 0),\n",
+    "        facecolor=plot_palette_raw[0] if filled_bars else (1, 1, 1, 0),\n",
     "        edgecolor=edge_colors,\n",
     "        zorder=1,\n",
     "        orient=orient,\n",
     "    )\n",
     "\n",
+    "    if filled_bars:\n",
+    "        barplot_kwargs['facecolor'] = plot_palette_raw[1]\n",
+    "        barplot_kwargs['edgecolor'] = 'black'\n",
+    "        barplot_kwargs['linewidth'] = 2\n",
+    "    else:\n",
+    "        barplot_kwargs['palette'] = plot_palette_raw\n",
+    "\n",
     "    bar2 = sns.barplot(\n",
     "        data=plot_data,\n",
     "        x=yvar if horizontal else xvar,\n",
     "        y=xvar if horizontal else yvar,\n",
     "        hue=xvar if color_col is None else color_col,\n",
     "        ax=rawdata_axes,\n",
     "        order=all_plot_groups,\n",
-    "        palette=plot_palette_raw,\n",
     "        dodge=False,\n",
     "        zorder=1,\n",
     "        orient=orient,\n",

nbs/API/plotter.ipynb

@@ -218,7 +218,7 @@
     "                                                                                idx = idx,\n",
     "                                                                                all_plot_groups = all_plot_groups,\n",
     "                                                                                delta2 = effectsize_df.delta2,\n",
-    "                                                                                sankey = True if proportional and show_pairs else False,\n",
+    "                                                                                proportional = proportional\n",
     "    )\n",
     "\n",
     "    # Initialise the figure.\n",

nbs/tests/mpl_image_tests/baseline_images/test_144_change_palette_d.png

@@ -459,6 +459,11 @@ def test_143_sankey_change_palette_c():
     plt.rcdefaults()
     return multi_groups_paired.mean_diff.plot(custom_palette=['red', 'blue'])
 
+@pytest.mark.mpl_image_compare(tolerance=8)
+def test_144_change_palette_d():
+    plt.rcdefaults()
+    return multi_2group.mean_diff.plot(custom_palette={0:'blue', 1: 'red'})
+
 @pytest.mark.mpl_image_compare(tolerance=8)
 def test_136_style_sheets():
     # Perform this test last so we don't have to reset the plot style.