man/importCellRangerV2Sample.Rd
8a33a64b
 % Generated by roxygen2: do not edit by hand
 % Please edit documentation in R/importCellRanger.R
 \name{importCellRangerV2Sample}
 \alias{importCellRangerV2Sample}
 \title{Construct SCE object from Cell Ranger V2 output for a single sample}
 \usage{
64d3a71f
 importCellRangerV2Sample(
82a6da93
   dataDir = NULL,
64d3a71f
   sampleName = NULL,
   class = c("Matrix", "matrix"),
dfe50c33
   delayedArray = FALSE,
   rowNamesDedup = TRUE
64d3a71f
 )
8a33a64b
 }
 \arguments{
82a6da93
 \item{dataDir}{A path to the directory containing the data files. Default "./".}
8a33a64b
 
 \item{sampleName}{A User-defined sample name. This will be prepended to all cell barcode IDs.
 Default "sample".}
 
 \item{class}{Character. The class of the expression matrix stored in the SCE
 object. Can be one of "Matrix" (as returned by
6fe21ae1
 \link{readMM} function), or "matrix" (as returned by
8a33a64b
 \link[base]{matrix} function). Default "Matrix".}
 
 \item{delayedArray}{Boolean. Whether to read the expression matrix as
969718f9
 \link{DelayedArray} object or not. Default \code{FALSE}.}
dfe50c33
 
 \item{rowNamesDedup}{Boolean. Whether to deduplicate rownames. Default 
 \code{TRUE}.}
8a33a64b
 }
 \value{
 A \code{SingleCellExperiment} object containing the count
  matrix, the feature annotations, and the cell annotation for the sample.
 }
 \description{
 Read the filtered barcodes, features, and matrices for all
82a6da93
  samples from Cell Ranger V2 output. Files are assumed to be named
8a33a64b
  "matrix.mtx", "genes.tsv", and "barcodes.tsv".
 }
82a6da93
 \examples{
 sce <- importCellRangerV2Sample(
73dfeffb
     dataDir = system.file("extdata/pbmc_4k_v2_20x20/outs/",
82a6da93
         "filtered_gene_bc_matrices/GRCh38", package = "singleCellTK"),
73dfeffb
     sampleName = "pbmc4k_20")
82a6da93
 }