6e7955a8 |
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/importAlevin.R
\name{importAlevin}
\alias{importAlevin}
\title{Construct SCE object from Salmon-Alevin output}
\usage{
|
d32b31c8 |
importAlevin(
alevinDir = NULL,
sampleName = "sample",
delayedArray = FALSE,
|
dfe50c33 |
class = c("Matrix", "matrix"),
rowNamesDedup = TRUE
|
d32b31c8 |
)
|
6e7955a8 |
}
\arguments{
|
02426619 |
\item{alevinDir}{Character. The output directory of salmon-Alevin pipeline.
|
3ce6e91e |
It should contain subfolder named 'alevin', which contains the count data
which is stored
|
6e7955a8 |
in 'quants_mat.gz'. Default \code{NULL}.}
\item{sampleName}{Character. A user-defined sample name for the sample to be
|
3ce6e91e |
imported. The 'sampleName' will be appended to the begining of cell
barcodes. Default is 'sample'.}
|
6e7955a8 |
\item{delayedArray}{Boolean. Whether to read the expression matrix as
\link{DelayedArray} object or not. Default \code{FALSE}.}
|
d32b31c8 |
\item{class}{Character. The class of the expression matrix stored in the SCE
object. Can be one of "Matrix" (as returned by
\link{readMM} function), or "matrix" (as returned by
\link[base]{matrix} function). Default "Matrix".}
|
dfe50c33 |
\item{rowNamesDedup}{Boolean. Whether to deduplicate rownames. Default
\code{TRUE}.}
|
6e7955a8 |
}
\value{
A \code{SingleCellExperiment} object containing the count
|
02426619 |
matrix, the feature annotations, and the cell annotation
|
6e7955a8 |
(which includes QC metrics stored in 'featureDump.txt').
}
\description{
Construct SCE object from Salmon-Alevin output
}
|