man/combineSCE.Rd
ece1f3d8
 % Generated by roxygen2: do not edit by hand
feff3b1d
 % Please edit documentation in R/combineSCE.R
ece1f3d8
 \name{combineSCE}
 \alias{combineSCE}
 \title{Combine a list of SingleCellExperiment objects as one SingleCellExperiment object}
 \usage{
431c970b
 combineSCE(sceList, by.r = NULL, by.c = NULL, combined = TRUE)
ece1f3d8
 }
 \arguments{
ea2808fc
 \item{sceList}{A list contains \link[SingleCellExperiment]{SingleCellExperiment} objects.
 Currently, combineSCE function only support combining SCE objects with assay in dgCMatrix format.
5daf7de2
 It does not support combining SCE with assay in delayedArray format.}
feff3b1d
 
431c970b
 \item{by.r}{Specifications of the columns used for merging rowData. If set as NULL, 
 the rownames of rowData tables will be used to merging rowData. Default is NULL.}
feff3b1d
 
431c970b
 \item{by.c}{Specifications of the columns used for merging colData. If set as NULL, 
 the rownames of colData tables will be used to merging colData. Default is NULL.}
feff3b1d
 
431c970b
 \item{combined}{logical; if TRUE, it will combine the list of SingleCellExperiment objects 
 and return a SingleCellExperiment. If FALSE, it will return a list of SingleCellExperiment whose
 rowData, colData, assay and reducedDim data slot are compatible within SCE objects in the list. 
 Default is TRUE.}
ece1f3d8
 }
 \value{
0ccddee1
 A \link[SingleCellExperiment]{SingleCellExperiment} object which combines all
ece1f3d8
 objects in sceList. The colData is merged.
 }
 \description{
 Combine a list of SingleCellExperiment objects as one SingleCellExperiment object
 }
0ccddee1
 \examples{
c36924bf
 data(scExample, package = "singleCellTK")
0ccddee1
 combinedsce <- combineSCE(list(sce,sce), by.r = NULL, by.c = NULL, combined = TRUE)
 }