Allow totals_plot_elements=0 to disable totals plot

jnothman · Dec 28, 2023 · 0916572 · 0916572
1 parent 9a00998
commit 0916572
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 5 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,3 +1,7 @@
+What's new in version 0.9
+-------------------------
+- Ability to disable totals plot with `totals_plot_elements=0`.
+
 What's new in version 0.8
 -------------------------
 

diff --git a/upsetplot/plotting.py b/upsetplot/plotting.py
@@ -244,7 +244,7 @@ class UpSet:
             Setting to 0 is handled.
     totals_plot_elements : int
         The totals plot should be large enough to fit this many matrix
-        elements.
+        elements. Use totals_plot_elements=0 to disable the totals plot.
     show_counts : bool or str, default=False
         Whether to label the intersection size bars with the cardinality
         of the intersection. When a string, this formats the number.
@@ -691,7 +691,9 @@ def make_grid(self, fig=None):
             out = {
                 "matrix": gridspec[-n_cats:, -n_inters:],
                 "shading": gridspec[-n_cats:, :],
-                "totals": gridspec[-n_cats:, : self._totals_plot_elements],
+                "totals": None
+                if self._totals_plot_elements == 0
+                else gridspec[-n_cats:, : self._totals_plot_elements],
                 "gs": gridspec,
             }
             cumsizes = np.cumsum(sizes[::-1])
@@ -703,7 +705,9 @@ def make_grid(self, fig=None):
             out = {
                 "matrix": gridspec[-n_inters:, :n_cats],
                 "shading": gridspec[:, :n_cats],
-                "totals": gridspec[: self._totals_plot_elements, :n_cats],
+                "totals": None
+                if self._totals_plot_elements == 0
+                else gridspec[: self._totals_plot_elements, :n_cats],
                 "gs": gridspec,
             }
             cumsizes = np.cumsum(sizes)
@@ -970,8 +974,13 @@ def plot(self, fig=None):
         self.plot_shading(shading_ax)
         matrix_ax = self._reorient(fig.add_subplot)(specs["matrix"], sharey=shading_ax)
         self.plot_matrix(matrix_ax)
-        totals_ax = self._reorient(fig.add_subplot)(specs["totals"], sharey=matrix_ax)
-        self.plot_totals(totals_ax)
+        if specs["totals"] is None:
+            totals_ax = None
+        else:
+            totals_ax = self._reorient(fig.add_subplot)(
+                specs["totals"], sharey=matrix_ax
+            )
+            self.plot_totals(totals_ax)
         out = {"matrix": matrix_ax, "shading": shading_ax, "totals": totals_ax}
 
         for plot in self._subset_plots:

diff --git a/upsetplot/tests/test_upsetplot.py b/upsetplot/tests/test_upsetplot.py
@@ -361,6 +361,7 @@ def test_param_validation(kw):
         {"intersection_plot_elements": 0},
         {"facecolor": "red"},
         {"shading_color": "lightgrey", "other_dots_color": "pink"},
+        {"totals_plot_elements": 0},
     ],
 )
 def test_plot_smoke_test(kw):