man/getSceParams.Rd
ece1f3d8
 % Generated by roxygen2: do not edit by hand
 % Please edit documentation in R/sctkQCUtils.R
 \name{getSceParams}
 \alias{getSceParams}
 \title{Extract QC parameters from the SingleCellExperiment object}
 \usage{
 getSceParams(
   inSCE,
44720f97
   skip = c("runScrublet", "runDecontX", "runBarcodeRanksMetaOutput", "genesets",
     "runSoupX"),
5d8e765a
   ignore = c("algorithms", "estimates", "contamination", "z", "sample", "rank",
a9f24dc0
     "BPPARAM", "batch", "geneSetCollection", "barcodeArgs"),
f5e1db0c
   directory = "./",
ece1f3d8
   samplename = "",
   writeYAML = TRUE
 )
 }
 \arguments{
 \item{inSCE}{A \link[SingleCellExperiment]{SingleCellExperiment} object.}
 
 \item{skip}{Skip extracting the parameters of the provided QC functions.}
 
 \item{ignore}{Skip extracting the content within QC functions.}
 
f5e1db0c
 \item{directory}{The output directory of the SCTK_runQC.R pipeline.}
 
ece1f3d8
 \item{samplename}{The sample name of the \link[SingleCellExperiment]{SingleCellExperiment} objects.}
 
ea450967
 \item{writeYAML}{Whether output yaml file to store parameters. Default if TRUE. If FALSE,
ece1f3d8
 return character object.}
 }
ce30e109
 \value{
 If \code{writeYAML} TRUE, a yaml object will be generated. If FALSE, character object.
 }
ece1f3d8
 \description{
 Extract QC parameters from the SingleCellExperiment object
 }