man/plotSeuratElbow.Rd
679e2352
 % Generated by roxygen2: do not edit by hand
 % Please edit documentation in R/seuratFunctions.R
0eafe06c
 \name{plotSeuratElbow}
 \alias{plotSeuratElbow}
 \title{plotSeuratElbow
3ce6e91e
 Computes the plot object for elbow plot from the pca slot in the input sce
 object}
679e2352
 \usage{
0eafe06c
 plotSeuratElbow(
80cd90bb
   inSCE,
   significantPC = NULL,
   reduction = "pca",
b827eb5d
   ndims = 20,
67c1a1e8
   externalReduction = NULL,
17738106
   interactive = FALSE
80cd90bb
 )
679e2352
 }
 \arguments{
3ce6e91e
 \item{inSCE}{(sce) object from which to compute the elbow plot (pca should
 be computed)}
55429919
 
3ce6e91e
 \item{significantPC}{Number of significant principal components to plot.
 This is used to alter the color of the points for the corresponding PCs.
 If \code{NULL}, all points will be the same color. Default \code{NULL}.}
9451938f
 
3ce6e91e
 \item{reduction}{Reduction to use for elbow plot generation. Either
 \code{"pca"} or \code{"ica"}. Default \code{"pca"}.}
80cd90bb
 
b827eb5d
 \item{ndims}{Number of components to use. Default \code{20}.}
 
3ce6e91e
 \item{externalReduction}{Pass DimReduc object if PCA/ICA computed through
 other libraries. Default \code{NULL}.}
67c1a1e8
 
 \item{interactive}{Logical value indicating if the returned object should
 be an interactive plotly object if \code{TRUE} or a ggplot object if
17738106
 set to \code{FALSE}. Default is \code{FALSE}.}
679e2352
 }
 \value{
 plot object
 }
 \description{
0eafe06c
 plotSeuratElbow
3ce6e91e
 Computes the plot object for elbow plot from the pca slot in the input sce
 object
679e2352
 }
0ccddee1
 \examples{
 data(scExample, package = "singleCellTK")
 \dontrun{
0eafe06c
 sce <- runSeuratNormalizeData(sce, useAssay = "counts")
 sce <- runSeuratFindHVG(sce, useAssay = "counts")
 sce <- runSeuratScaleData(sce, useAssay = "counts")
 sce <- runSeuratPCA(sce, useAssay = "counts")
 plotSeuratElbow(sce)
0ccddee1
 }
 }