Renders a component containing a horizontal barplot.

Renders a component containing a horizontal barplot.

barplot(dashboard, object, ...)

# S4 method for i2dashboard,missing
barplot(
  dashboard,
  y_group_by,
  x_group_by = NULL,
  title = NULL,
  x_group_by_title = NULL,
  y_group_by_title = NULL,
  transmitter = NULL
)

# S4 method for i2dashboard,SingleCellExperiment
barplot(
  dashboard,
  object,
  y_group_by = NULL,
  x_group_by = NULL,
  from = c("colData", "rowData"),
  ...
)

# S4 method for i2dashboard,Seurat
barplot(
  dashboard,
  object,
  y_group_by = NULL,
  x_group_by = NULL,
  from = c("meta.data", "meta.features"),
  assay = "RNA",
  ...
)

Arguments

dashboard

An object of class i2dashboard.
object

An object of class Seurat or SingleCellExperiment.
...

Further parameters passed to the core function.
y_group_by

Data containing grouping factors for the vertical axis.
x_group_by

Optionally provide data containing grouping factors for the horizontal axis. The result is a barplot grouped by the levels in x_group_by and shows the relative number of its observations.
title

The title of the components junk.
x_group_by_title

The title of the x-axis.
y_group_by_title

The title of the y-axis.
transmitter

A character defining the id of an existing transmitter to obtain the data from.
from

A character specifying where to obtain the data from (see Details).
assay

A character defining the assay of object and is used for obtaining the meta data of the respective assay (default "RNA") (see Details).

Value

A string containing markdown code for the rendered component

Details

The parameters y_group_by, x_group_by take different arguments depending on the class of object. In case of the i2dashboard,missing-method, the parameters are expected to be of class data.frame or matrix. In case of the i2dashboard,SingleCellExperiment or i2dashboard,Seurat method, the parameters are expected to be of class character and

  • from can either be "colData" or "rowData" for a SingleCellExperiment object or

  • "meta.data" or "meta.features" for a Seurat object.

In both cases, y_group_by and x_group_by take column names of from.