... | ... |
@@ -8,7 +8,8 @@ importCellRangerV2Sample( |
8 | 8 |
dataDir = NULL, |
9 | 9 |
sampleName = NULL, |
10 | 10 |
class = c("Matrix", "matrix"), |
11 |
- delayedArray = FALSE |
|
11 |
+ delayedArray = FALSE, |
|
12 |
+ rowNamesDedup = TRUE |
|
12 | 13 |
) |
13 | 14 |
} |
14 | 15 |
\arguments{ |
... | ... |
@@ -24,6 +25,9 @@ object. Can be one of "Matrix" (as returned by |
24 | 25 |
|
25 | 26 |
\item{delayedArray}{Boolean. Whether to read the expression matrix as |
26 | 27 |
\link{DelayedArray} object or not. Default \code{FALSE}.} |
28 |
+ |
|
29 |
+\item{rowNamesDedup}{Boolean. Whether to deduplicate rownames. Default |
|
30 |
+\code{TRUE}.} |
|
27 | 31 |
} |
28 | 32 |
\value{ |
29 | 33 |
A \code{SingleCellExperiment} object containing the count |
... | ... |
@@ -8,7 +8,7 @@ importCellRangerV2Sample( |
8 | 8 |
dataDir = NULL, |
9 | 9 |
sampleName = NULL, |
10 | 10 |
class = c("Matrix", "matrix"), |
11 |
- delayedArray = TRUE |
|
11 |
+ delayedArray = FALSE |
|
12 | 12 |
) |
13 | 13 |
} |
14 | 14 |
\arguments{ |
... | ... |
@@ -23,7 +23,7 @@ object. Can be one of "Matrix" (as returned by |
23 | 23 |
\link[base]{matrix} function). Default "Matrix".} |
24 | 24 |
|
25 | 25 |
\item{delayedArray}{Boolean. Whether to read the expression matrix as |
26 |
-\link{DelayedArray} object or not. Default \code{TRUE}.} |
|
26 |
+\link{DelayedArray} object or not. Default \code{FALSE}.} |
|
27 | 27 |
} |
28 | 28 |
\value{ |
29 | 29 |
A \code{SingleCellExperiment} object containing the count |
... | ... |
@@ -19,11 +19,11 @@ Default "sample".} |
19 | 19 |
|
20 | 20 |
\item{class}{Character. The class of the expression matrix stored in the SCE |
21 | 21 |
object. Can be one of "Matrix" (as returned by |
22 |
-\link[Matrix]{readMM} function), or "matrix" (as returned by |
|
22 |
+\link{readMM} function), or "matrix" (as returned by |
|
23 | 23 |
\link[base]{matrix} function). Default "Matrix".} |
24 | 24 |
|
25 | 25 |
\item{delayedArray}{Boolean. Whether to read the expression matrix as |
26 |
-\link[DelayedArray]{DelayedArray} object or not. Default \code{TRUE}.} |
|
26 |
+\link{DelayedArray} object or not. Default \code{TRUE}.} |
|
27 | 27 |
} |
28 | 28 |
\value{ |
29 | 29 |
A \code{SingleCellExperiment} object containing the count |
... | ... |
@@ -36,7 +36,7 @@ Read the filtered barcodes, features, and matrices for all |
36 | 36 |
} |
37 | 37 |
\examples{ |
38 | 38 |
sce <- importCellRangerV2Sample( |
39 |
- dataDir = system.file("extdata/pbmc_4k_v2_200x400/outs/", |
|
39 |
+ dataDir = system.file("extdata/pbmc_4k_v2_20x20/outs/", |
|
40 | 40 |
"filtered_gene_bc_matrices/GRCh38", package = "singleCellTK"), |
41 |
- sampleName = "pbmc400") |
|
41 |
+ sampleName = "pbmc4k_20") |
|
42 | 42 |
} |
... | ... |
@@ -36,7 +36,7 @@ Read the filtered barcodes, features, and matrices for all |
36 | 36 |
} |
37 | 37 |
\examples{ |
38 | 38 |
sce <- importCellRangerV2Sample( |
39 |
- dataDir = system.file("extdata/pbmc_4k_v2_200x800/pbmc_800/outs/", |
|
39 |
+ dataDir = system.file("extdata/pbmc_4k_v2_200x400/outs/", |
|
40 | 40 |
"filtered_gene_bc_matrices/GRCh38", package = "singleCellTK"), |
41 |
- sampleName = "pbmc800") |
|
41 |
+ sampleName = "pbmc400") |
|
42 | 42 |
} |
... | ... |
@@ -36,7 +36,7 @@ Read the filtered barcodes, features, and matrices for all |
36 | 36 |
} |
37 | 37 |
\examples{ |
38 | 38 |
sce <- importCellRangerV2Sample( |
39 |
- dataDir = system.file("extdata/pbmc_4k_v2_200x800/outs/", |
|
39 |
+ dataDir = system.file("extdata/pbmc_4k_v2_200x800/pbmc_800/outs/", |
|
40 | 40 |
"filtered_gene_bc_matrices/GRCh38", package = "singleCellTK"), |
41 | 41 |
sampleName = "pbmc800") |
42 | 42 |
} |
... | ... |
@@ -36,7 +36,7 @@ Read the filtered barcodes, features, and matrices for all |
36 | 36 |
} |
37 | 37 |
\examples{ |
38 | 38 |
sce <- importCellRangerV2Sample( |
39 |
- dataDir = system.file("extdata/pbmc_4k_v2_800/outs/", |
|
39 |
+ dataDir = system.file("extdata/pbmc_4k_v2_200x800/outs/", |
|
40 | 40 |
"filtered_gene_bc_matrices/GRCh38", package = "singleCellTK"), |
41 | 41 |
sampleName = "pbmc800") |
42 | 42 |
} |
... | ... |
@@ -5,14 +5,14 @@ |
5 | 5 |
\title{Construct SCE object from Cell Ranger V2 output for a single sample} |
6 | 6 |
\usage{ |
7 | 7 |
importCellRangerV2Sample( |
8 |
- sampleDir = NULL, |
|
8 |
+ dataDir = NULL, |
|
9 | 9 |
sampleName = NULL, |
10 | 10 |
class = c("Matrix", "matrix"), |
11 | 11 |
delayedArray = TRUE |
12 | 12 |
) |
13 | 13 |
} |
14 | 14 |
\arguments{ |
15 |
-\item{sampleDir}{A path to the directory containing the data files. Default "./".} |
|
15 |
+\item{dataDir}{A path to the directory containing the data files. Default "./".} |
|
16 | 16 |
|
17 | 17 |
\item{sampleName}{A User-defined sample name. This will be prepended to all cell barcode IDs. |
18 | 18 |
Default "sample".} |
... | ... |
@@ -31,6 +31,12 @@ A \code{SingleCellExperiment} object containing the count |
31 | 31 |
} |
32 | 32 |
\description{ |
33 | 33 |
Read the filtered barcodes, features, and matrices for all |
34 |
- samples from Cell Ranger V3 output. Files are assumed to be named |
|
34 |
+ samples from Cell Ranger V2 output. Files are assumed to be named |
|
35 | 35 |
"matrix.mtx", "genes.tsv", and "barcodes.tsv". |
36 | 36 |
} |
37 |
+\examples{ |
|
38 |
+sce <- importCellRangerV2Sample( |
|
39 |
+ dataDir = system.file("extdata/pbmc_4k_v2_800/outs/", |
|
40 |
+ "filtered_gene_bc_matrices/GRCh38", package = "singleCellTK"), |
|
41 |
+ sampleName = "pbmc800") |
|
42 |
+} |
... | ... |
@@ -4,8 +4,12 @@ |
4 | 4 |
\alias{importCellRangerV2Sample} |
5 | 5 |
\title{Construct SCE object from Cell Ranger V2 output for a single sample} |
6 | 6 |
\usage{ |
7 |
-importCellRangerV2Sample(sampleDir = NULL, sampleName = NULL, |
|
8 |
- class = c("Matrix", "matrix"), delayedArray = TRUE) |
|
7 |
+importCellRangerV2Sample( |
|
8 |
+ sampleDir = NULL, |
|
9 |
+ sampleName = NULL, |
|
10 |
+ class = c("Matrix", "matrix"), |
|
11 |
+ delayedArray = TRUE |
|
12 |
+) |
|
9 | 13 |
} |
10 | 14 |
\arguments{ |
11 | 15 |
\item{sampleDir}{A path to the directory containing the data files. Default "./".} |
... | ... |
@@ -4,12 +4,8 @@ |
4 | 4 |
\alias{importCellRangerV2Sample} |
5 | 5 |
\title{Construct SCE object from Cell Ranger V2 output for a single sample} |
6 | 6 |
\usage{ |
7 |
-importCellRangerV2Sample( |
|
8 |
- sampleDir = NULL, |
|
9 |
- sampleName = NULL, |
|
10 |
- class = c("Matrix", "matrix"), |
|
11 |
- delayedArray = TRUE |
|
12 |
-) |
|
7 |
+importCellRangerV2Sample(sampleDir = NULL, sampleName = NULL, |
|
8 |
+ class = c("Matrix", "matrix"), delayedArray = TRUE) |
|
13 | 9 |
} |
14 | 10 |
\arguments{ |
15 | 11 |
\item{sampleDir}{A path to the directory containing the data files. Default "./".} |
1 | 1 |
new file mode 100644 |
... | ... |
@@ -0,0 +1,36 @@ |
1 |
+% Generated by roxygen2: do not edit by hand |
|
2 |
+% Please edit documentation in R/importCellRanger.R |
|
3 |
+\name{importCellRangerV2Sample} |
|
4 |
+\alias{importCellRangerV2Sample} |
|
5 |
+\title{Construct SCE object from Cell Ranger V2 output for a single sample} |
|
6 |
+\usage{ |
|
7 |
+importCellRangerV2Sample( |
|
8 |
+ sampleDir = NULL, |
|
9 |
+ sampleName = NULL, |
|
10 |
+ class = c("Matrix", "matrix"), |
|
11 |
+ delayedArray = TRUE |
|
12 |
+) |
|
13 |
+} |
|
14 |
+\arguments{ |
|
15 |
+\item{sampleDir}{A path to the directory containing the data files. Default "./".} |
|
16 |
+ |
|
17 |
+\item{sampleName}{A User-defined sample name. This will be prepended to all cell barcode IDs. |
|
18 |
+Default "sample".} |
|
19 |
+ |
|
20 |
+\item{class}{Character. The class of the expression matrix stored in the SCE |
|
21 |
+object. Can be one of "Matrix" (as returned by |
|
22 |
+\link[Matrix]{readMM} function), or "matrix" (as returned by |
|
23 |
+\link[base]{matrix} function). Default "Matrix".} |
|
24 |
+ |
|
25 |
+\item{delayedArray}{Boolean. Whether to read the expression matrix as |
|
26 |
+\link[DelayedArray]{DelayedArray} object or not. Default \code{TRUE}.} |
|
27 |
+} |
|
28 |
+\value{ |
|
29 |
+A \code{SingleCellExperiment} object containing the count |
|
30 |
+ matrix, the feature annotations, and the cell annotation for the sample. |
|
31 |
+} |
|
32 |
+\description{ |
|
33 |
+Read the filtered barcodes, features, and matrices for all |
|
34 |
+ samples from Cell Ranger V3 output. Files are assumed to be named |
|
35 |
+ "matrix.mtx", "genes.tsv", and "barcodes.tsv". |
|
36 |
+} |