reportClusterAbundance: Get plotClusterAbundance .html report

In compbiomed/singleCellTK: Comprehensive and Interactive Analysis of Single Cell RNA-Seq Data

Get plotClusterAbundance .html report

Description

A function to generate .html Rmarkdown report containing the visualizations of the plotClusterAbundance function output

Usage

reportClusterAbundance(
  inSCE,
  cluster,
  variable,
  output_dir = ".",
  output_file = "plotClusterAbundance_Report",
  pdf = FALSE,
  showSession = TRUE
)

Arguments

inSCE	A SingleCellExperiment object.
cluster	A single character, specifying the name to store the cluster label in colData.
variable	A single character, specifying the name to store the phenotype labels in colData.
output_dir	name of the output directory to save the rendered file. If NULL the file is stored to the current working directory. Default NULL.
output_file	name of the generated file. If NULL then the output file name will be based on the name of the Rmarkdown template. Default NULL.
pdf	A logical value indicating if a pdf should also be generated for each figure in the report. Default is TRUE.
showSession	A logical value indicating if session information should be displayed or not. Default is TRUE.

Value

An HTML file of the report will be generated at the path specified in the arguments.

compbiomed/singleCellTK documentation built on Oct. 27, 2024, 3:26 a.m.