man/runScanpyNormalizeData.Rd
8ffa2535
 % Generated by roxygen2: do not edit by hand
 % Please edit documentation in R/scanpyFunctions.R
 \name{runScanpyNormalizeData}
 \alias{runScanpyNormalizeData}
 \title{runScanpyNormalizeData
 Wrapper for NormalizeData() function from scanpy library
fda0528a
 Normalizes the sce object according to the input parameters}
8ffa2535
 \usage{
 runScanpyNormalizeData(
   inSCE,
   useAssay,
d01ac247
   targetSum = 10000,
95e7b4f3
   maxFraction = 0.05,
bc3e63f7
   normAssayName = "scanpyNormData"
8ffa2535
 )
 }
 \arguments{
 \item{inSCE}{(sce) object to normalize}
 
 \item{useAssay}{Assay containing raw counts to use for normalization.}
 
95e7b4f3
 \item{targetSum}{If NULL, after normalization, each observation (cell) has a 
 total count equal to the median of total counts for observations (cells) 
d01ac247
 before normalization. Default \code{1e4}}
bc3e63f7
 
95e7b4f3
 \item{maxFraction}{Include cells that have more counts than max_fraction of 
 the original total counts in at least one cell. Default \code{0.05}}
bc3e63f7
 
8ffa2535
 \item{normAssayName}{Name of new assay containing normalized data. Default
 \code{scanpyNormData}.}
 }
 \value{
 Normalized \code{SingleCellExperiment} object
 }
 \description{
 runScanpyNormalizeData
 Wrapper for NormalizeData() function from scanpy library
fda0528a
 Normalizes the sce object according to the input parameters
8ffa2535
 }
 \examples{
 data(scExample, package = "singleCellTK")
4f02e9c2
 sce <- subsetSCECols(sce, colData = "type != 'EmptyDroplet'")
 rownames(sce) <- rowData(sce)$feature_name
8ffa2535
 \dontrun{
 sce <- runScanpyNormalizeData(sce, useAssay = "counts")
 }
 }