man/runSeuratIntegration.Rd
8a70b39e
 % Generated by roxygen2: do not edit by hand
 % Please edit documentation in R/seuratFunctions.R
0eafe06c
 \name{runSeuratIntegration}
 \alias{runSeuratIntegration}
 \title{runSeuratIntegration
8a70b39e
 A wrapper function to Seurat Batch-Correction/Integration workflow.}
 \usage{
0eafe06c
 runSeuratIntegration(
8a70b39e
   inSCE,
   useAssay = "counts",
   batch,
   newAssayName = "SeuratIntegratedAssay",
   kAnchor,
   kFilter,
   kWeight,
   ndims = 10
 )
 }
 \arguments{
3ce6e91e
 \item{inSCE}{Input \code{SingleCellExperiment} object that contains the assay
 to batch-correct.}
8a70b39e
 
 \item{useAssay}{Assay to batch-correct.}
 
3ce6e91e
 \item{batch}{Batch variable from \code{colData} slot of
 \code{SingleCellExperiment} object.}
8a70b39e
 
ce128daf
 \item{newAssayName}{Assay name for the batch-corrected output assay.}
8a70b39e
 
3ce6e91e
 \item{kAnchor}{Number of neighbours to use for finding the anchors in the
 \link[Seurat]{FindIntegrationAnchors} function.}
8a70b39e
 
3ce6e91e
 \item{kFilter}{Number of neighbours to use for filtering the anchors in the
 \link[Seurat]{FindIntegrationAnchors} function.}
8a70b39e
 
3ce6e91e
 \item{kWeight}{Number of neighbours to use when weigthing the anchors in the
 \link[Seurat]{IntegrateData} function.}
8a70b39e
 
 \item{ndims}{Number of dimensions to use. Default \code{10}.}
 }
 \value{
3ce6e91e
 A \code{SingleCellExperiment} object that contains the
 batch-corrected assay inside the \code{altExp} slot of the object
8a70b39e
 }
 \description{
0eafe06c
 runSeuratIntegration
8a70b39e
 A wrapper function to Seurat Batch-Correction/Integration workflow.
 }