Add a feature expression page.

This function adds a page with two linked components to the dashboard object: A scatterplot, showing samples in along two-dimensional coordinates, and a violin plot, showing feature expression values by groups defined in group_by.

add_feature_expression_page(dashboard, object, ...)

# S4 method for i2dashboard,missing
add_feature_expression_page(
  dashboard,
  use_dimred,
  exprs_values,
  group_by = NULL,
  labels = rownames(use_dimred),
  title = "Feature expression",
  menu = NULL,
  page = "feature_expression_page"
)

# S4 method for i2dashboard,SingleCellExperiment
add_feature_expression_page(
  dashboard,
  object,
  use_dimred,
  exprs_values,
  group_by = NULL,
  subset_row = NULL,
  ...
)

# S4 method for i2dashboard,Seurat
add_feature_expression_page(
  dashboard,
  object,
  use_dimred,
  assay,
  group_by,
  slot = "data",
  subset_row = NULL,
  ...
)

Arguments

dashboard	An object of class i2dashboard.
object	A valid SingleCellExperiment or Seurat object.
...	Further parameters passed to the core function.
use_dimred	Coordinates of the reduced dimensions, used for the scatterplot (see Details).
exprs_values	Expression data of features of interest in rows and samples in columns (see Details).
group_by	Data along samples that is used for grouping expression values in the violin plot (see Details).
labels	A vector with optional sample labels that are used instead of rownames(use_dimred).
title	The title of the page.
menu	(Optional) The name of the menu, under which the page should appear.
page	The name of the page to be added.
subset_row	A character vector (of feature names), a logical vector or numeric vector (of indices) specifying the features to use. The default of NULL will use all features.
assay	A character vector specifying which assay from object@assays to obtain expression values from (see Details).
slot	A character vector specifying the name of the slot in the assay.

Value

An object of class i2dashboard.

Details

The parameters use_dimred, exprs_values (or assay) and group_by take different arguments depending on the class of object. In case no object is supplied (i2dashboard,missing-method), the parameters are expected to be of class data.frame or matrix. In case a SingleCellExperiment or Seurat object is supplied, the parameters are expected to be of class character, containing

• the name of a item in reducedDims(object) or object@reductions,

• a valid assay name from assayNames(object) or names(object@assays),

• column names of colData(object) or object@meta.data.