Added argument for showing/hiding the sample size in labels and updated readme

Author: JAnns98

README.md

@@ -15,7 +15,7 @@ citation](https://zenodo.org/badge/DOI/10.1038/s41592-019-0470-3.svg)](https://r
 ## Recent Version Update
 
 We are proud to announce **DABEST Version Dadar (v2025.03.14)** This new
-version of the DABEST Python library provides several new features and
+version of the DABEST Python library includes several new features and
 performance improvements. It’s a big one!
 
 1.  **Python 3.13 Support**: DABEST now supports Python 3.10-3.13.

dabest/_effsize_objects.py

@@ -1138,6 +1138,7 @@ def plot(
         err_color=None,
         float_contrast=True,
         show_pairs=True,
+        show_sample_size=True,
         show_delta2=True,
         show_mini_meta=True,
         group_summaries=None,
@@ -1263,6 +1264,8 @@ def plot(
             If the data is paired, whether or not to show the raw data as a
             swarmplot, or as slopegraph, with a line joining each pair of
             observations.
+        show_sample_size : boolean, default True
+            Whether or not to display the sample size of each group in the axis label.
         show_delta2, show_mini_meta : boolean, default True
             If delta-delta or mini-meta delta is calculated, whether or not to
             show the delta-delta plot or mini-meta plot.

dabest/plotter.py

@@ -39,6 +39,7 @@ def effectsize_df_plotter(effectsize_df: object, **plot_kwargs) -> matplotlib.fi
         ci=None, ci_type='bca', err_color=None,
         float_contrast=True,
         show_pairs=True,
+        show_sample_size=True,
         show_delta2=True,
         group_summaries=None,
         fig_size=None,
@@ -290,15 +291,16 @@ def effectsize_df_plotter(effectsize_df: object, **plot_kwargs) -> matplotlib.fi
             )
 
     # Add the counts to the rawdata axes xticks.
-    add_counts_to_ticks(
-            plot_data = plot_data, 
-            xvar = xvar, 
-            yvar = yvar, 
-            rawdata_axes = rawdata_axes, 
-            plot_kwargs = plot_kwargs,
-            flow = sankey_kwargs["flow"],
-            horizontal = horizontal,
-    )
+    if plot_kwargs['show_sample_size']:
+        add_counts_to_ticks(
+                plot_data = plot_data, 
+                xvar = xvar, 
+                yvar = yvar, 
+                rawdata_axes = rawdata_axes, 
+                plot_kwargs = plot_kwargs,
+                flow = sankey_kwargs["flow"],
+                horizontal = horizontal,
+        )
 
     # Add counts to prop plots (embedded in the plot bars)
     if proportional and plot_kwargs['prop_sample_counts'] and sankey_kwargs["flow"]:

nbs/API/effsize_objects.ipynb

@@ -1338,6 +1338,7 @@
     "        err_color=None,\n",
     "        float_contrast=True,\n",
     "        show_pairs=True,\n",
+    "        show_sample_size=True,\n",
     "        show_delta2=True,\n",
     "        show_mini_meta=True,\n",
     "        group_summaries=None,\n",
@@ -1463,6 +1464,8 @@
     "            If the data is paired, whether or not to show the raw data as a\n",
     "            swarmplot, or as slopegraph, with a line joining each pair of\n",
     "            observations.\n",
+    "        show_sample_size : boolean, default True\n",
+    "            Whether or not to display the sample size of each group in the axis label.\n",
     "        show_delta2, show_mini_meta : boolean, default True\n",
     "            If delta-delta or mini-meta delta is calculated, whether or not to\n",
     "            show the delta-delta plot or mini-meta plot.\n",

nbs/API/plotter.ipynb

@@ -96,6 +96,7 @@
     "        ci=None, ci_type='bca', err_color=None,\n",
     "        float_contrast=True,\n",
     "        show_pairs=True,\n",
+    "        show_sample_size=True,\n",
     "        show_delta2=True,\n",
     "        group_summaries=None,\n",
     "        fig_size=None,\n",
@@ -347,15 +348,16 @@
     "            )\n",
     "\n",
     "    # Add the counts to the rawdata axes xticks.\n",
-    "    add_counts_to_ticks(\n",
-    "            plot_data = plot_data, \n",
-    "            xvar = xvar, \n",
-    "            yvar = yvar, \n",
-    "            rawdata_axes = rawdata_axes, \n",
-    "            plot_kwargs = plot_kwargs,\n",
-    "            flow = sankey_kwargs[\"flow\"],\n",
-    "            horizontal = horizontal,\n",
-    "    )\n",
+    "    if plot_kwargs['show_sample_size']:\n",
+    "        add_counts_to_ticks(\n",
+    "                plot_data = plot_data, \n",
+    "                xvar = xvar, \n",
+    "                yvar = yvar, \n",
+    "                rawdata_axes = rawdata_axes, \n",
+    "                plot_kwargs = plot_kwargs,\n",
+    "                flow = sankey_kwargs[\"flow\"],\n",
+    "                horizontal = horizontal,\n",
+    "        )\n",
     "\n",
     "    # Add counts to prop plots (embedded in the plot bars)\n",
     "    if proportional and plot_kwargs['prop_sample_counts'] and sankey_kwargs[\"flow\"]:\n",

nbs/read_me.ipynb

@@ -29,7 +29,7 @@
    "source": [
     "## Recent Version Update\n",
     "\n",
-    "We are proud to announce **DABEST Version Dadar (v2025.03.14)** This new version of the DABEST Python library provides several new features and performance improvements. It's a big one!\n",
+    "We are proud to announce **DABEST Version Dadar (v2025.03.14)** This new version of the DABEST Python library includes several new features and performance improvements. It's a big one!\n",
     "\n",
     "1. **Python 3.13 Support**: DABEST now supports Python 3.10-3.13.\n",
     "\n",