decoupler.bm.pl.summary#

decoupler.bm.pl.summary(df, y, metrics=None, cmap_y='tab20', cmap_auc='Greens', cmap_fscore='Blues', cmap_qrank='Reds', **kwargs)#

Summarizes metrics into a final score by computing the quantile-normalized rank across them.

Parameters:
df DataFrame

Result of decoupler.bm.benchmark.

y str

Grouping variable to plot on y axis.

metrics list | None (default: None)

Which metrics to include.

cmap_y str (default: 'tab20')

Color map for the y grouping.

cmap_auc str (default: 'Greens')

Color map for the auc metric.

cmap_fscore str (default: 'Blues')

Color map for the fscore metric.

cmap_qrank str (default: 'Reds')

Color map for the qrank metric.

ax

An existing matplotlib.axes._axes.Axes instance to plot on. If None, a new figure and axes will be created.

figsize

Size of the figure in inches as (width, height).

dpi

Dots per inch for the figure resolution.

return_fig

If True, plotting methods should return the figure object instead of showing it.

save

If set, path to save the plot automatically to a file.

Return type:

None | Figure

Returns:

If return_fig=True, returns matplotlib.figure.Figure instance.