decoupler.plot_metrics_scatter

decoupler.plot_metrics_scatter(df, x='auroc', y='auprc', groupby=None, show_text=True, show_legend=True, mirror_xy=True, figsize=(5, 5), dpi=100, ax=None, title=None, xlabel=None, ylabel=None, color='black', return_fig=False, save=None)

Plot scatter plot of metrics across two different axes.

Parameters:
dfDataFrame

Performance metrics per method, obtained by running run_benchmark.

xstr

Name of the metric to plot in the x axis.

ystr

Name of the metric to plot in the y axis.

groupbystr

Metrics can be gruped by an extra categorical column.

show_textbool

Whether to plot text labels.

show_legendbool

Whether to plot the legend.

mirror_xybool

Whether to make x and y axis have the same values.

figsizetuple

Figure size.

dpiint

DPI resolution of figure.

axAxes, None

A matplotlib axes object. If None returns new figure.

titlestr

Text to write as title of the plot.

xlabelstr

Text to write as xlabel of the plot.

ylabelstr

Text to write as ylabel of the plot.

colorstr

Color to plot the dots.

return_figbool

Whether to return a Figure object or not.

savestr, None

Path to where to save the plot. Infer the filetype if ending on {.pdf, .png, .svg}.

Returns:
figFigure, None

If return_fig, returns Figure object.