ROC and AUC Plot Function — ROCandAUCplot • markeR

This function computes ROC curves and AUC values for each gene based on gene expression data and sample metadata. It can generate ROC plots, an AUC heatmap / barplot, or both arranged side‐by‐side.

Usage

ROCandAUCplot(
  data,
  metadata,
  genes = NULL,
  condition_var,
  class,
  group_var = NULL,
  plot_type = "roc",
  title = NULL,
  titlesize = 14,
  roc_params = list(),
  auc_params = list(),
  commomplot_params = list()
)

Arguments

data

A data frame or matrix containing gene expression data, with genes as rows and samples as columns.

metadata

A data frame containing sample metadata. The first column should contain sample identifiers that match the column names of data.

genes

A character vector specifying which genes to plot. If NULL (default), all genes in data are used. A warning is issued if more than 30 genes are selected.

condition_var

A character string specifying the column name in metadata representing the condition of interest. (Mandatory; no default.)

class

A character string or vector specifying the positive class label for the condition. (Mandatory; no default.)

group_var

An optional character string specifying the column name in metadata used for grouping samples (e.g., cell types). If not provided (NULL), all samples are treated as a single group. Should be a categorical variable.

plot_type

A character string indicating which plot(s) to generate. Accepted values are "roc" (only ROC curves), "auc" (only the AUC heatmap/barplot), or "all" (both arranged side-by-side). Default is "roc".

title

An optional character string specifying the main title of the plot.

titlesize

A numeric value specifying the size of the title. Default is 14.

roc_params

A list of additional parameters for customizing the ROC plot. Possible elements include:

nrow: An integer specifying the number of rows in the ROC plot grid. If NULL (default), it is calculated automatically.
ncol: An integer specifying the number of columns in the ROC plot grid. If NULL (default), it is calculated automatically.
colors: A named vector of colors for the different groups. If NULL (default), a default color palette is generated.

auc_params

A list of additional parameters for customizing the AUC heatmap or AUC barplot. Possible elements include:

cluster_rows: Logical; if TRUE (default), rows are clustered.
cluster_columns: Logical; if TRUE (default), columns are clustered.
colors: If group_var is used, should be a vector of length 2 of colors to be used for the minimum and maximum values of the color scale. Defaults to c("#FFFFFF", "#21975C"). If group_var is NULL, then should be a single color to fill the barplot. If NULL, defaults to "#3B415B". If a vector is provided, only the first color will be used.
limits: A numeric vector of length 2 specifying the minimum and maximum values for the color scale. If not provided, defaults to c(0.5, 1).
name: A character string for the legend title of the color scale. Default is "AUC".
row_names_gp: Optional graphical parameters for row names (passed to ComplexHeatmap).
column_names_gp: Optional graphical parameters for column names (passed to ComplexHeatmap).

commomplot_params

A list of parameters for customizing the layout of the combined plot when plot_type = "all". Possible elements include:

widths: A numeric vector specifying the relative widths of the ROC and heatmap panels.
heights: A numeric vector specifying the relative heights of the panels.

Value

Invisibly returns a list containing:

roc_plot: The ggplot2 object of the ROC curves (if generated).
heatmap: The ComplexHeatmap object (if generated).
combined: The combined grid arrangement (if plot_type = "all").
auc_values: A data frame with the calculated AUC values.

Details

The function processes gene expression data and metadata to compute ROC curves and AUC values for each gene. Depending on the value of plot_type, it produces ROC plots (using ggplot2), an AUC heatmap (using ComplexHeatmap) or AUC barplot (if group_var is NULL), or both arranged side-by-side (using gridExtra).

Examples

if (FALSE) { # \dontrun{
  # Example: Generate both ROC plots and heatmap with custom parameters
  result <- ROCandAUCplot(data = myData,
                          metadata = myMetadata,
                          genes = c("Gene1", "Gene2", "Gene3"),
                          condition_var = "Genotype",
                          class = "Mutant",
                          group_var = "CellType",
                          plot_type = "all",
                          title = "My Custom Title",
                          roc_params = list(ncol = 3),
                          auc_params= list(limits = c(0.4, 1)),
                          commomplot_params = list(widths = c(1, 1)))
} # }