Updated Gridkey function for horizontal plot and delta-delta and mini-meta integration

Author: JAnns98

dabest/_modidx.py

@@ -117,7 +117,7 @@
                                                                                     'dabest/plot_tools.py'),
                                    'dabest.plot_tools.error_bar': ('API/plot_tools.html#error_bar', 'dabest/plot_tools.py'),
                                    'dabest.plot_tools.get_swarm_spans': ('API/plot_tools.html#get_swarm_spans', 'dabest/plot_tools.py'),
-                                   'dabest.plot_tools.grid_key_WIP': ('API/plot_tools.html#grid_key_wip', 'dabest/plot_tools.py'),
+                                   'dabest.plot_tools.gridkey_plotter': ('API/plot_tools.html#gridkey_plotter', 'dabest/plot_tools.py'),
                                    'dabest.plot_tools.halfviolin': ('API/plot_tools.html#halfviolin', 'dabest/plot_tools.py'),
                                    'dabest.plot_tools.normalize_dict': ('API/plot_tools.html#normalize_dict', 'dabest/plot_tools.py'),
                                    'dabest.plot_tools.plot_minimeta_or_deltadelta_violins': ( 'API/plot_tools.html#plot_minimeta_or_deltadelta_violins',

dabest/misc_tools.py

@@ -390,6 +390,7 @@ def get_kwargs(plot_kwargs, ytick_color):
     else:
         table_kwargs = merge_two_dicts(default_table_kwargs, plot_kwargs["horizontal_table_kwargs"])
 
+    # Return the kwargs.
     return (swarmplot_kwargs, barplot_kwargs, sankey_kwargs, violinplot_kwargs, slopegraph_kwargs, 
             reflines_kwargs, legend_kwargs, group_summary_kwargs, redraw_axes_kwargs, delta_dot_kwargs,
             delta_text_kwargs, summary_bars_kwargs, swarm_bars_kwargs, contrast_bars_kwargs, table_kwargs)
@@ -593,7 +594,8 @@ def initialize_fig(plot_kwargs, dabest_obj, show_delta2, show_mini_meta, is_pair
     init_fig_kwargs = dict(figsize=fig_size, dpi=plot_kwargs["dpi"], tight_layout=True)
 
     width_ratios_ga = [2.5, 1]
-    h_space_cummings = 0.3 if plot_kwargs["gridkey_rows"] == None else 0.1     ##### GRIDKEY WIP addition
+    h_space_cummings = (0.1 if plot_kwargs["gridkey_rows"] is not None
+                        else 0.3)
 
     if plot_kwargs["ax"] is not None:
         # New in v0.2.6.
@@ -1430,7 +1432,7 @@ def Cumming_Plot_Aesthetic_Adjustments(contrast_axes, reflines_kwargs, is_paired
                 del redraw_axes_kwargs["y"]
 
     # Add x-spine line for delta2/mini meta.
-    if (show_delta2 or show_mini_meta) and not horizontal:
+    if (show_delta2 or show_mini_meta) and not horizontal and not skip_redraw_lines:
         ylim = contrast_axes.get_ylim()
         redraw_axes_kwargs["y"] = ylim[0]
         x_ticks = contrast_axes.get_xticks()

dabest/plot_tools.py

@@ -9,7 +9,7 @@
 __all__ = ['halfviolin', 'get_swarm_spans', 'error_bar', 'check_data_matches_labels', 'normalize_dict', 'width_determine',
            'single_sankey', 'sankeydiag', 'summary_bars_plotter', 'contrast_bars_plotter', 'swarm_bars_plotter',
            'delta_text_plotter', 'DeltaDotsPlotter', 'slopegraph_plotter', 'plot_minimeta_or_deltadelta_violins',
-           'effect_size_curve_plotter', 'grid_key_WIP', 'barplotter', 'table_for_horizontal_plots', 'swarmplot',
+           'effect_size_curve_plotter', 'gridkey_plotter', 'barplotter', 'table_for_horizontal_plots', 'swarmplot',
            'SwarmPlot']
 
 # %% ../nbs/API/plot_tools.ipynb 4
@@ -1609,9 +1609,10 @@ def effect_size_curve_plotter(ticks_to_plot, results, ci_type, contrast_axes, vi
     return current_group, current_control, current_effsize, contrast_xtick_labels
 
 
-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, x1_level, experiment_label):
+def gridkey_plotter(is_paired, idx, all_plot_groups, gridkey_rows, rawdata_axes, contrast_axes, 
+                 plot_data, xvar, yvar, results, show_delta2, show_mini_meta, 
+                 plot_kwargs, x1_level, experiment_label, float_contrast, horizontal,
+                 delta_delta, mini_meta_delta, effect_size):
 
     gridkey_delimiters=plot_kwargs["gridkey_delimiters"] # Auto parser for gridkey - implemented by SangyuXu
     if gridkey_rows == "auto":
@@ -1697,7 +1698,7 @@ def grid_key_WIP(is_paired, idx, all_plot_groups, gridkey_rows, rawdata_axes, co
         table_cellcols.append(list_of_Ns)
 
     # Adds a row for effectsizes with effectsize values
-    if gridkey_show_es:
+    if gridkey_show_es and not horizontal:
         gridkey_rows.append("\u0394")
         effsize_list = []
         results_list = results.test.to_list()
@@ -1721,40 +1722,102 @@ def grid_key_WIP(is_paired, idx, all_plot_groups, gridkey_rows, rawdata_axes, co
 
         table_cellcols.append(effsize_list)
 
-    # If Gardner-Altman plot, plot on raw data and not contrast axes
-    if float_contrast:
-        axes_ploton = rawdata_axes
+    # Set the axes to plot on
+    if float_contrast or horizontal:
+        ax_to_plot = rawdata_axes
     else:
-        axes_ploton = contrast_axes
-
-    # Account for extended x axis in case of show_delta2 or show_mini_meta
-    x_groups_for_width = len(groups_for_gridkey)
-    if show_delta2 or show_mini_meta:
-        x_groups_for_width += 2
-    gridkey_width = len(groups_for_gridkey) / x_groups_for_width
-
-    gridkey = axes_ploton.table(
-        cellText=table_cellcols,
-        rowLabels=gridkey_rows,
-        cellLoc="center",
-        bbox=[
-            0,
-            -len(gridkey_rows) * 0.1 - 0.05,
-            gridkey_width,
-            len(gridkey_rows) * 0.1,
-        ],
-        **{"alpha": 0.5}
-    )
+        ax_to_plot = contrast_axes
+
+    # Add delta-delta or mini_meta details to the table
+    if show_mini_meta or show_delta2:
+        if show_delta2:
+            added_group_name = ["deltas' g"] if effect_size == "delta_g" else ["delta-delta"]
+        else:
+            added_group_name = ["Weighted delta"]
+        gridkey_rows = added_group_name + gridkey_rows
+        table_cellcols = [[""]*len(table_cellcols[0])] + table_cellcols
+
+        for group_idx, group_vals in enumerate(table_cellcols):
+            if group_idx == 0:
+                added_group = ['', "\u25CF"]
+            elif gridkey_show_es and (group_idx == len(table_cellcols)-1) and not horizontal:
+                added_delta_effectsize = delta_delta.difference if show_delta2 else mini_meta_delta.difference
+                added_delta_effectsize_str = np.format_float_positional(
+                                                                        added_delta_effectsize,
+                                                                        precision=2,
+                                                                        sign=True,
+                                                                        trim="k",
+                                                                        min_digits=2,
+                                                                    )
+                added_group = ['-', added_delta_effectsize_str]
+            else:
+                added_group = ['', '']
+            for n in added_group:
+                group_vals.append(n)
 
-    # modifies row label cells
-    for cell in gridkey._cells:
-        if cell[1] == -1:
-            gridkey._cells[cell].visible_edges = "open"
-            gridkey._cells[cell].set_text_props(**{"ha": "right"})
+    # Create the table object
+    if horizontal:
+        # Convert the cells format for horizontal table plotting
+        converted_list = []
+        for j in range(0, len(table_cellcols[0])):
+            temp_list = []
+            for i in table_cellcols:
+                temp_list.append(i[j])
+            converted_list.append(temp_list)
+
+        # Plot the table for horizontal format
+        gridkey = ax_to_plot.table(
+            cellText=converted_list,
+            cellLoc="center",
+            bbox=[
+                -len(gridkey_rows) * 0.2, 
+                0, 
+                len(gridkey_rows) * 0.2, 
+                1
+            ],
+            **{"alpha": 0.5, "zorder": 5}
+            )
+        
+        # Add the column labels as text below the table
+        text_locs = np.arange((-len(gridkey_rows)*0.2) +0.1, 0, 0.2)
+        for loc, txt in zip(text_locs, gridkey_rows):
+            ax_to_plot.text(
+                        loc+0.04, 
+                        -0.01, 
+                        txt, 
+                        transform=ax_to_plot.transAxes, 
+                        fontsize=10,
+                        ha='right',
+                        rotation=45,
+                        va='top'
+                    )
+    else:
+        # Plot the table for vertical format
+        gridkey = ax_to_plot.table(
+            cellText=table_cellcols,
+            rowLabels=gridkey_rows,
+            cellLoc="center",
+            bbox=[
+                0,
+                -len(gridkey_rows) * 0.1 - 0.05,
+                1,
+                len(gridkey_rows) * 0.1,
+            ],
+            **{"alpha": 0.5}
+        )
+        # modifies row label cells
+        for cell in gridkey._cells:
+            if cell[1] == -1:
+                gridkey._cells[cell].visible_edges = "open"
+                gridkey._cells[cell].set_text_props(**{"ha": "right"})
 
     # turns off both x axes
-    rawdata_axes.get_xaxis().set_visible(False)
-    contrast_axes.get_xaxis().set_visible(False)
+    if horizontal:
+        rawdata_axes.get_yaxis().set_visible(False)
+        contrast_axes.get_yaxis().set_visible(False)
+    else:
+        rawdata_axes.get_xaxis().set_visible(False)
+        contrast_axes.get_xaxis().set_visible(False)
 
 def barplotter(xvar, yvar, all_plot_groups, rawdata_axes, plot_data, bar_color, plot_palette_bar, 
                plot_kwargs, barplot_kwargs, horizontal):

dabest/plotter.py

@@ -90,7 +90,7 @@ def effectsize_df_plotter(effectsize_df, **plot_kwargs):
         slopegraph_plotter,
         plot_minimeta_or_deltadelta_violins,
         effect_size_curve_plotter,
-        grid_key_WIP,
+        gridkey_plotter,
         barplotter,
         table_for_horizontal_plots,
     )
@@ -378,30 +378,6 @@ def effectsize_df_plotter(effectsize_df, **plot_kwargs):
                                                                 redraw_axes_kwargs=redraw_axes_kwargs,
                                                                 horizontal=horizontal,
                                                                 )
-        
-    # GRIDKEY  WIP
-    skip_redraw_lines = False
-    gridkey_rows = plot_kwargs["gridkey_rows"]
-    if gridkey_rows is not None and not horizontal:
-        grid_key_WIP(
-                is_paired=is_paired, 
-                idx=idx, 
-                all_plot_groups=all_plot_groups, 
-                gridkey_rows=gridkey_rows, 
-                rawdata_axes=rawdata_axes, 
-                contrast_axes=contrast_axes,
-                plot_data=plot_data, 
-                xvar=xvar, 
-                yvar=yvar, 
-                results=results, 
-                show_delta2=show_delta2, 
-                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
 
     # Make sure the contrast_axes x-lims match the rawdata_axes xlims,
     # and add an extra violinplot tick for delta-delta plot.
@@ -457,6 +433,8 @@ def effectsize_df_plotter(effectsize_df, **plot_kwargs):
                                             )
     else:
         # For Cumming Plots only.
+        # skip_redraw_lines = True if plot_kwargs["gridkey_rows"] is not None and not any([show_mini_meta, show_delta2]) else False
+        skip_redraw_lines = True if plot_kwargs["gridkey_rows"] is not None else False
         Cumming_Plot_Aesthetic_Adjustments(
                                     contrast_axes=contrast_axes, 
                                     reflines_kwargs=reflines_kwargs, 
@@ -569,6 +547,35 @@ def effectsize_df_plotter(effectsize_df, **plot_kwargs):
                             show_delta2=show_delta2,
                             table_kwargs=table_kwargs,
                             )
+        
+
+    # GRIDKEY  WIP
+    gridkey_rows = plot_kwargs["gridkey_rows"]
+    # if gridkey_rows is not None and not any([show_mini_meta, show_delta2]):
+    if gridkey_rows is not None:
+        gridkey_plotter(
+                is_paired=is_paired, 
+                idx=idx, 
+                all_plot_groups=all_plot_groups, 
+                gridkey_rows=gridkey_rows, 
+                rawdata_axes = rawdata_axes,
+                contrast_axes = contrast_axes,
+                plot_data=plot_data, 
+                xvar=xvar, 
+                yvar=yvar, 
+                results=results, 
+                show_delta2=show_delta2, 
+                show_mini_meta=show_mini_meta, 
+                plot_kwargs=plot_kwargs,
+                x1_level=x1_level,
+                experiment_label=experiment_label,
+                float_contrast=float_contrast,
+                horizontal=horizontal,
+                delta_delta = effectsize_df.delta_delta if show_delta2 else None,
+                mini_meta_delta = effectsize_df.mini_meta_delta if show_mini_meta else None,
+                effect_size = effect_size,
+                )
+
 
     # Make sure no stray ticks appear!
     rawdata_axes.xaxis.set_ticks_position("bottom")

nbs/API/misc_tools.ipynb

@@ -443,6 +443,7 @@
     "    else:\n",
     "        table_kwargs = merge_two_dicts(default_table_kwargs, plot_kwargs[\"horizontal_table_kwargs\"])\n",
     "\n",
+    "    # Return the kwargs.\n",
     "    return (swarmplot_kwargs, barplot_kwargs, sankey_kwargs, violinplot_kwargs, slopegraph_kwargs, \n",
     "            reflines_kwargs, legend_kwargs, group_summary_kwargs, redraw_axes_kwargs, delta_dot_kwargs,\n",
     "            delta_text_kwargs, summary_bars_kwargs, swarm_bars_kwargs, contrast_bars_kwargs, table_kwargs)\n",
@@ -646,7 +647,8 @@
     "    init_fig_kwargs = dict(figsize=fig_size, dpi=plot_kwargs[\"dpi\"], tight_layout=True)\n",
     "\n",
     "    width_ratios_ga = [2.5, 1]\n",
-    "    h_space_cummings = 0.3 if plot_kwargs[\"gridkey_rows\"] == None else 0.1     ##### GRIDKEY WIP addition\n",
+    "    h_space_cummings = (0.1 if plot_kwargs[\"gridkey_rows\"] is not None\n",
+    "                        else 0.3)\n",
     "\n",
     "    if plot_kwargs[\"ax\"] is not None:\n",
     "        # New in v0.2.6.\n",
@@ -1483,7 +1485,7 @@
     "                del redraw_axes_kwargs[\"y\"]\n",
     "\n",
     "    # Add x-spine line for delta2/mini meta.\n",
-    "    if (show_delta2 or show_mini_meta) and not horizontal:\n",
+    "    if (show_delta2 or show_mini_meta) and not horizontal and not skip_redraw_lines:\n",
     "        ylim = contrast_axes.get_ylim()\n",
     "        redraw_axes_kwargs[\"y\"] = ylim[0]\n",
     "        x_ticks = contrast_axes.get_xticks()\n",