Added changes From Sangyu's PR for gridkey auto parser

Author: JAnns98

dabest/_effsize_objects.py

@@ -1001,6 +1001,7 @@ def plot(
         gridkey_merge_pairs=False,
         gridkey_show_Ns=True,
         gridkey_show_es=True,
+        gridkey_delimiters=[';', '>', '_'],
         swarmplot_kwargs=None,
         barplot_kwargs=None,
         violinplot_kwargs=None,
@@ -1122,7 +1123,18 @@ def plot(
         gridkey_rows : list, default None
             Provide a list of row labels for the gridkey. The supplied idx is
             checked against the row labels to determine whether the corresponding
-            cell should be populated or not.
+            cell should be populated or not. 
+            This can also be set to "auto", which will attempt to auto populate the table.
+        gridkey_merge_pairs : boolean, default False
+            If True, the gridkey will merge the pairs of groups into a single
+            cell. This is useful for when the groups are paired.
+        gridkey_show_Ns : boolean, default True
+            If True, the gridkey will show the number of observations in each
+            group.
+        gridkey_show_es : boolean, default True
+            If True, the gridkey will show the effect size of each comparison.
+        gridkey_delimiters : list, default [';', '>', '_']
+            The delimiters used to separate the group names in the gridkey.
         swarmplot_kwargs : dict, default None
             Pass any keyword arguments accepted by the seaborn `swarmplot`
             command here, as a dict. If None, the following keywords are
@@ -1180,7 +1192,6 @@ def plot(
         fontsize_delta2label : float, default 12
             Font size for the delta-delta axes ylabel.
             
-            
         contrast_bars : boolean, default True
             Whether or not to display the contrast bars.
         swarm_bars : boolean, default True

dabest/misc_tools.py

@@ -116,6 +116,8 @@ def get_params(effectsize_df, plot_kwargs):
     dabest_obj = effectsize_df.dabest_obj
     all_plot_groups = dabest_obj._all_plot_groups
     idx = dabest_obj.idx
+    x1_level = dabest_obj.x1_level
+    experiment_label = dabest_obj.experiment_label
 
 
     if effect_size not in ["mean_diff", "delta_g"] or not delta2:
@@ -170,7 +172,7 @@ def get_params(effectsize_df, plot_kwargs):
 
     return (dabest_obj, plot_data, xvar, yvar, is_paired, effect_size, proportional, all_plot_groups, idx, 
             show_delta2, show_mini_meta, float_contrast, show_pairs, effect_size_type, group_summaries, err_color, horizontal,
-            results, es_marker_size, halfviolin_alpha, ci_type)
+            results, es_marker_size, halfviolin_alpha, ci_type, x1_level, experiment_label)
 
 def get_kwargs(plot_kwargs, ytick_color):
     """

dabest/plot_tools.py

@@ -1572,7 +1572,21 @@ def effect_size_curve_plotter(ticks_to_plot, results, ci_type, contrast_axes, vi
 
 
 def grid_key_WIP(is_paired, idx, all_plot_groups, gridkey_rows, rawdata_axes, contrast_axes,
-                 plot_data, xvar, yvar, results, show_delta2, show_mini_meta, float_contrast, plot_kwargs,):
+                 plot_data, xvar, yvar, results, show_delta2, show_mini_meta, float_contrast, 
+                 plot_kwargs, x1_level, experiment_label):
+    
+    gridkey_delimiters=plot_kwargs["gridkey_delimiters"] # Auto parser for gridkey - implemented by SangyuXu
+    if gridkey_rows == "auto":
+        if experiment_label is not None:
+            gridkey_rows = list(np.concatenate([experiment_label, x1_level]))
+        else:
+            temp_groups = ";".join(all_plot_groups)
+            for delimiter in gridkey_delimiters:
+                temp_groups = temp_groups.replace(delimiter, ";")
+            temp_groups = [i.strip() for i in temp_groups.split(';')]
+            unique_groups = list(set(temp_groups))
+            rank = [sum([temp_groups.index(i) for i in temp_groups if(j in i)]) for j in unique_groups]
+            gridkey_rows = [x for _,x in sorted(zip(rank,unique_groups))]
 
     gridkey_show_Ns=plot_kwargs["gridkey_show_Ns"]
     gridkey_show_es=plot_kwargs["gridkey_show_es"]

dabest/plotter.py

@@ -113,10 +113,11 @@ def effectsize_df_plotter(effectsize_df, **plot_kwargs):
     ytick_color = plt.rcParams["ytick.color"]
 
     # Extract parameters and set kwargs
-    (dabest_obj, plot_data, xvar, yvar, is_paired, effect_size, 
-     proportional, all_plot_groups, idx, show_delta2, show_mini_meta, 
-     float_contrast, show_pairs, effect_size_type, group_summaries, 
-     err_color, horizontal, results, es_marker_size, halfviolin_alpha, ci_type) = get_params(
+    (dabest_obj, plot_data, xvar, yvar, is_paired, 
+     effect_size, proportional, all_plot_groups, idx, show_delta2, 
+     show_mini_meta, float_contrast, show_pairs, effect_size_type, 
+     group_summaries, err_color, horizontal, results, 
+     es_marker_size, halfviolin_alpha, ci_type, x1_level, experiment_label) = get_params(
                                                                                     effectsize_df=effectsize_df, 
                                                                                     plot_kwargs=plot_kwargs,
                                                                                     )
@@ -397,6 +398,8 @@ def effectsize_df_plotter(effectsize_df, **plot_kwargs):
                 show_mini_meta=show_mini_meta, 
                 float_contrast=float_contrast,
                 plot_kwargs=plot_kwargs,
+                x1_level=x1_level,
+                experiment_label=experiment_label,
                 )
         skip_redraw_lines = True
 

nbs/API/effsize_objects.ipynb

@@ -1160,6 +1160,7 @@
     "        gridkey_merge_pairs=False,\n",
     "        gridkey_show_Ns=True,\n",
     "        gridkey_show_es=True,\n",
+    "        gridkey_delimiters=[';', '>', '_'],\n",
     "        swarmplot_kwargs=None,\n",
     "        barplot_kwargs=None,\n",
     "        violinplot_kwargs=None,\n",
@@ -1281,7 +1282,18 @@
     "        gridkey_rows : list, default None\n",
     "            Provide a list of row labels for the gridkey. The supplied idx is\n",
     "            checked against the row labels to determine whether the corresponding\n",
-    "            cell should be populated or not.\n",
+    "            cell should be populated or not. \n",
+    "            This can also be set to \"auto\", which will attempt to auto populate the table.\n",
+    "        gridkey_merge_pairs : boolean, default False\n",
+    "            If True, the gridkey will merge the pairs of groups into a single\n",
+    "            cell. This is useful for when the groups are paired.\n",
+    "        gridkey_show_Ns : boolean, default True\n",
+    "            If True, the gridkey will show the number of observations in each\n",
+    "            group.\n",
+    "        gridkey_show_es : boolean, default True\n",
+    "            If True, the gridkey will show the effect size of each comparison.\n",
+    "        gridkey_delimiters : list, default [';', '>', '_']\n",
+    "            The delimiters used to separate the group names in the gridkey.\n",
     "        swarmplot_kwargs : dict, default None\n",
     "            Pass any keyword arguments accepted by the seaborn `swarmplot`\n",
     "            command here, as a dict. If None, the following keywords are\n",
@@ -1339,7 +1351,6 @@
     "        fontsize_delta2label : float, default 12\n",
     "            Font size for the delta-delta axes ylabel.\n",
     "            \n",
-    "            \n",
     "        contrast_bars : boolean, default True\n",
     "            Whether or not to display the contrast bars.\n",
     "        swarm_bars : boolean, default True\n",

nbs/API/misc_tools.ipynb

@@ -169,6 +169,8 @@
     "    dabest_obj = effectsize_df.dabest_obj\n",
     "    all_plot_groups = dabest_obj._all_plot_groups\n",
     "    idx = dabest_obj.idx\n",
+    "    x1_level = dabest_obj.x1_level\n",
+    "    experiment_label = dabest_obj.experiment_label\n",
     "    \n",
     "\n",
     "    if effect_size not in [\"mean_diff\", \"delta_g\"] or not delta2:\n",
@@ -223,7 +225,7 @@
     "        \n",
     "    return (dabest_obj, plot_data, xvar, yvar, is_paired, effect_size, proportional, all_plot_groups, idx, \n",
     "            show_delta2, show_mini_meta, float_contrast, show_pairs, effect_size_type, group_summaries, err_color, horizontal,\n",
-    "            results, es_marker_size, halfviolin_alpha, ci_type)\n",
+    "            results, es_marker_size, halfviolin_alpha, ci_type, x1_level, experiment_label)\n",
     "\n",
     "def get_kwargs(plot_kwargs, ytick_color):\n",
     "    \"\"\"\n",

nbs/API/plot_tools.ipynb

@@ -1622,7 +1622,21 @@
     "\n",
     "\n",
     "def grid_key_WIP(is_paired, idx, all_plot_groups, gridkey_rows, rawdata_axes, contrast_axes,\n",
-    "                 plot_data, xvar, yvar, results, show_delta2, show_mini_meta, float_contrast, plot_kwargs,):\n",
+    "                 plot_data, xvar, yvar, results, show_delta2, show_mini_meta, float_contrast, \n",
+    "                 plot_kwargs, x1_level, experiment_label):\n",
+    "    \n",
+    "    gridkey_delimiters=plot_kwargs[\"gridkey_delimiters\"] # Auto parser for gridkey - implemented by SangyuXu\n",
+    "    if gridkey_rows == \"auto\":\n",
+    "        if experiment_label is not None:\n",
+    "            gridkey_rows = list(np.concatenate([experiment_label, x1_level]))\n",
+    "        else:\n",
+    "            temp_groups = \";\".join(all_plot_groups)\n",
+    "            for delimiter in gridkey_delimiters:\n",
+    "                temp_groups = temp_groups.replace(delimiter, \";\")\n",
+    "            temp_groups = [i.strip() for i in temp_groups.split(';')]\n",
+    "            unique_groups = list(set(temp_groups))\n",
+    "            rank = [sum([temp_groups.index(i) for i in temp_groups if(j in i)]) for j in unique_groups]\n",
+    "            gridkey_rows = [x for _,x in sorted(zip(rank,unique_groups))]\n",
     "    \n",
     "    gridkey_show_Ns=plot_kwargs[\"gridkey_show_Ns\"]\n",
     "    gridkey_show_es=plot_kwargs[\"gridkey_show_es\"]\n",

nbs/API/plotter.ipynb

@@ -170,10 +170,11 @@
     "    ytick_color = plt.rcParams[\"ytick.color\"]\n",
     "\n",
     "    # Extract parameters and set kwargs\n",
-    "    (dabest_obj, plot_data, xvar, yvar, is_paired, effect_size, \n",
-    "     proportional, all_plot_groups, idx, show_delta2, show_mini_meta, \n",
-    "     float_contrast, show_pairs, effect_size_type, group_summaries, \n",
-    "     err_color, horizontal, results, es_marker_size, halfviolin_alpha, ci_type) = get_params(\n",
+    "    (dabest_obj, plot_data, xvar, yvar, is_paired, \n",
+    "     effect_size, proportional, all_plot_groups, idx, show_delta2, \n",
+    "     show_mini_meta, float_contrast, show_pairs, effect_size_type, \n",
+    "     group_summaries, err_color, horizontal, results, \n",
+    "     es_marker_size, halfviolin_alpha, ci_type, x1_level, experiment_label) = get_params(\n",
     "                                                                                    effectsize_df=effectsize_df, \n",
     "                                                                                    plot_kwargs=plot_kwargs,\n",
     "                                                                                    )\n",
@@ -454,6 +455,8 @@
     "                show_mini_meta=show_mini_meta, \n",
     "                float_contrast=float_contrast,\n",
     "                plot_kwargs=plot_kwargs,\n",
+    "                x1_level=x1_level,\n",
+    "                experiment_label=experiment_label,\n",
     "                )\n",
     "        skip_redraw_lines = True\n",
     "    \n",