decoupler.bm.pl.auc

Contents

decoupler.bm.pl.auc#

decoupler.bm.pl.auc(df, hue=None, palette='tab20', thr_auroc=0.5, thr_auprc=0.5, **kwargs)#

Plot auroc and auprc.

x-axis represent the auroc calculated by ranking all obtained enrichment scores, calculating different class thresholds and finally obtaining the area under the curve. The higher value the better performance is.

y-axis represent the auprc calculated by ranking all obtained enrichment scores, calculating different class thresholds and finally obtaining the area under the curve. The higher value the better performance is.

Parameters:

  • df (DataFrame) – Result of decoupler.bm.benchmark.

  • hue (str | None (default: None)) – Grouping variable that will produce different colors.

  • palette (str (default: 'tab20')) – Method for choosing the colors to use

  • thr_auroc (float (default: 0.5)) – Dashed line to indicate baseline of auroc.

  • thr_auprc (float (default: 0.5)) – Dashed line to indicate baseline of auprc.

  • 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.

Contents