man/runClusterSummaryMetrics.Rd
5992e49b
 % Generated by roxygen2: do not edit by hand
 % Please edit documentation in R/runClusterSummaryMetrics.R
 \name{runClusterSummaryMetrics}
 \alias{runClusterSummaryMetrics}
 \title{Run Cluster Summary Metrics}
 \usage{
 runClusterSummaryMetrics(
   inSCE,
   useAssay = "logcounts",
4a5b5f77
   featureNames,
b888cc1e
   displayName = NULL,
61da00f2
   groupNames = "cluster",
   scale = FALSE
5992e49b
 )
 }
 \arguments{
 \item{inSCE}{The single cell experiment to use.}
 
 \item{useAssay}{The assay to use.}
 
4a5b5f77
 \item{featureNames}{A string or vector of strings with each gene to aggregate.}
5992e49b
 
 \item{displayName}{A string that is the name of the column used for genes.}
 
4a5b5f77
 \item{groupNames}{The name of a colData entry that can be used as groupNames.}
61da00f2
 
d6c4f292
 \item{scale}{Option to scale the data. Default: \code{FALSE}. Selected assay will not be scaled.}
5992e49b
 }
 \value{
 A dataframe with mean expression and percent of cells in cluster that 
 express for each cluster.
 }
 \description{
 Calculates the mean expression of percent of cells that express the
 given genes for each cluster
 }
 \examples{
30cf9713
 data("scExample")
4a5b5f77
 runClusterSummaryMetrics(inSCE=sce, useAssay="counts", featureNames=c("B2M", "MALAT1"), 
 displayName="feature_name", groupNames="type")
5992e49b
 }