Skip to contents

Wrapper function for volcano plot parameters

params_volcano.Rd

Wrapper function for volcano plot parameters

Usage

params_volcano(
  x_axis = "log2FC",
  y_axis = "FDR",
  colour = NULL,
  label_column = NULL,
  top_features_to_label = NULL
)

Arguments

x_axis

String. Column holding the effect size (e.g. "log2FC"). Defaults to "log2FC".

y_axis

String. Column holding the raw significance values (e.g. "FDR", "fdr", "q_value"). The function applies -log10() internally. Defaults to "FDR".

colour

String or NULL. Column to colour points by (continuous gradient). If NULL, points are coloured by x_axis. Defaults to NULL.

label_column

String or NULL. Column holding feature labels. Required if top_features_to_label is set. Defaults to NULL.

top_features_to_label

Integer or NULL. Number of features to label, ranked by y_axis ascending (most significant first). Defaults to NULL.

Value

A named list with the following elements:

  • x_axis - String. Column holding the effect size (e.g. "log2FC"). Defaults to "log2FC".

  • y_axis - String. Column holding the raw significance values (e.g. "FDR", "fdr", "q_value"). The function applies -log10() internally. Defaults to "FDR".

  • colour - String or NULL. Column to colour points by (continuous gradient). If NULL, points are coloured by x_axis. Defaults to NULL.

  • label_column - String or NULL. Column holding feature labels. Required if top_features_to_label is set. Defaults to NULL.

  • top_features_to_label - Integer or NULL. Number of features to label, ranked by y_axis ascending (most significant first). Defaults to NULL.