adds plot_upset function to the InteractionValues

shapiq/interaction_values.py

@@ -716,3 +716,15 @@ def plot_sentence(
         from shapiq.plot.sentence import sentence_plot
 
         return sentence_plot(self, words, show=show, **kwargs)
+
+    def plot_upset(self, show: bool = True, **kwargs) -> Optional[plt.Figure]:
+        """Plots the upset plot.
+
+        For arguments, see shapiq.plot.upset_plot().
+
+        Returns:
+            The upset plot as a matplotlib figure (if show is ``False``).
+        """
+        from shapiq.plot.upset import upset_plot
+
+        return upset_plot(self, show=show, **kwargs)

tests/tests_plots/test_upset.py

@@ -41,16 +41,21 @@ def test_upset_plot():
     assert isinstance(fig, plt.Figure)
     plt.close("all")
 
-    fp = upset_plot(iv, feature_names=feature_names, color_matrix=True, show=True)
-    assert fp is None
+    fig = upset_plot(iv, feature_names=feature_names, color_matrix=True, show=True)
+    assert fig is None
     plt.close("all")
 
     # in the following feature 3 is not shown
-    fp = upset_plot(iv, n_interactions=5, all_features=False, show=False)
+    fig = upset_plot(iv, n_interactions=5, all_features=False, show=False)
     assert isinstance(fig, plt.Figure)
     plt.close("all")
 
     # in the following feature 3 is shown
-    fp = upset_plot(iv, n_interactions=5, all_features=True, show=False)
+    fig = upset_plot(iv, n_interactions=5, all_features=True, show=False)
+    assert isinstance(fig, plt.Figure)
+    plt.close("all")
+
+    # test once directly from the interaction values
+    fig = iv.plot_upset(feature_names=feature_names, show=False)
     assert isinstance(fig, plt.Figure)
     plt.close("all")