man/plotClusterAbundance.Rd
2d8ecbf8
 % Generated by roxygen2: do not edit by hand
 % Please edit documentation in R/abundance.R
 \name{plotClusterAbundance}
 \alias{plotClusterAbundance}
 \title{Plot the differential Abundance}
 \usage{
f1f6421e
 plotClusterAbundance(inSCE, cluster, variable, combinePlot = c("all", "none"))
2d8ecbf8
 }
 \arguments{
 \item{inSCE}{A \code{\link[SingleCellExperiment]{SingleCellExperiment}}
 object.}
 
 \item{cluster}{A single \code{character}, specifying the name to store the
 cluster label in \code{\link{colData}}.}
 
 \item{variable}{A single \code{character}, specifying the name to store the
 phenotype labels in \code{\link{colData}}.}
f1f6421e
 
 \item{combinePlot}{Must be either "all" or "none". "all" will combine all 
 plots into a single \code{\link[ggplot2]{ggplot}} object. Default 
 \code{"all"}.}
2d8ecbf8
 }
 \value{
f1f6421e
 When \code{combinePlot = "none"}, a \code{list} with 4 
 \code{\link[ggplot2]{ggplot}} objects; when \code{combinePlot = "all"}, a 
 single \code{\link[ggplot2]{ggplot}} object with for subplots.
2d8ecbf8
 }
 \description{
 Plot the differential Abundance
 }
 \details{
 This function will visualize the differential abundance in two given
 variables, by making bar plots that presents the cell counting and fraction
 in different cases.
 }
 \examples{
 data("mouseBrainSubsetSCE", package = "singleCellTK")
 plotClusterAbundance(inSCE = mouseBrainSubsetSCE,
                      cluster = "tissue",
                      variable = "level1class")
 }