... | ... |
@@ -28,12 +28,15 @@ It can be 'Droplets'(raw droplets matrix) or 'Cells' (cells matrix).} |
28 | 28 |
\item{format}{The format of output. It currently supports flat files, rds files |
29 | 29 |
and python h5 files. It can output multiple formats. Default: c("SCE", "AnnData", "FlatFile", "HTAN").} |
30 | 30 |
} |
31 |
-<<<<<<< HEAD |
|
32 |
-======= |
|
33 | 31 |
\value{ |
34 | 32 |
Generates a file containing data from \code{inSCE}, in specified \code{format}. |
35 | 33 |
} |
36 |
->>>>>>> compbiomed-master |
|
37 | 34 |
\description{ |
38 | 35 |
Export data in SingleCellExperiment object |
39 | 36 |
} |
37 |
+\examples{ |
|
38 |
+data(scExample) |
|
39 |
+\dontrun{ |
|
40 |
+exportSCE(sce, format = "SCE") |
|
41 |
+} |
|
42 |
+} |
... | ... |
@@ -29,7 +29,7 @@ It can be 'Droplets'(raw droplets matrix) or 'Cells' (cells matrix).} |
29 | 29 |
and python h5 files. It can output multiple formats. Default: c("SCE", "AnnData", "FlatFile", "HTAN").} |
30 | 30 |
} |
31 | 31 |
\value{ |
32 |
-Generates a file containing data from \code{inSCE} as \code{format}. |
|
32 |
+Generates a file containing data from \code{inSCE}, in specified \code{format}. |
|
33 | 33 |
} |
34 | 34 |
\description{ |
35 | 35 |
Export data in SingleCellExperiment object |
... | ... |
@@ -13,8 +13,8 @@ exportSCE( |
13 | 13 |
) |
14 | 14 |
} |
15 | 15 |
\arguments{ |
16 |
-\item{inSCE}{A \link[SingleCellExperiment]{SingleCellExperiment} object |
|
17 |
-that contains the data. QC metrics are stored in colData of the |
|
16 |
+\item{inSCE}{A \link[SingleCellExperiment]{SingleCellExperiment} object |
|
17 |
+that contains the data. QC metrics are stored in colData of the |
|
18 | 18 |
singleCellExperiment object.} |
19 | 19 |
|
20 | 20 |
\item{samplename}{Sample name. This will be used as name of subdirectories |
... | ... |
@@ -22,7 +22,7 @@ and the prefix of flat file output. Default is 'sample'.} |
22 | 22 |
|
23 | 23 |
\item{directory}{Output directory. Default is './'.} |
24 | 24 |
|
25 |
-\item{type}{Type of data. The type of data stored in SingleCellExperiment object. |
|
25 |
+\item{type}{Type of data. The type of data stored in SingleCellExperiment object. |
|
26 | 26 |
It can be 'Droplets'(raw droplets matrix) or 'Cells' (cells matrix).} |
27 | 27 |
|
28 | 28 |
\item{format}{The format of output. It currently supports flat files, rds files |
... | ... |
@@ -13,8 +13,8 @@ exportSCE( |
13 | 13 |
) |
14 | 14 |
} |
15 | 15 |
\arguments{ |
16 |
-\item{inSCE}{A \link[SingleCellExperiment]{SingleCellExperiment} object |
|
17 |
-that contains the data. QC metrics are stored in colData of the |
|
16 |
+\item{inSCE}{A \link[SingleCellExperiment]{SingleCellExperiment} object |
|
17 |
+that contains the data. QC metrics are stored in colData of the |
|
18 | 18 |
singleCellExperiment object.} |
19 | 19 |
|
20 | 20 |
\item{samplename}{Sample name. This will be used as name of subdirectories |
... | ... |
@@ -22,7 +22,7 @@ and the prefix of flat file output. Default is 'sample'.} |
22 | 22 |
|
23 | 23 |
\item{directory}{Output directory. Default is './'.} |
24 | 24 |
|
25 |
-\item{type}{Type of data. The type of data stored in SingleCellExperiment object. |
|
25 |
+\item{type}{Type of data. The type of data stored in SingleCellExperiment object. |
|
26 | 26 |
It can be 'Droplets'(raw droplets matrix) or 'Cells' (cells matrix).} |
27 | 27 |
|
28 | 28 |
\item{format}{The format of output. It currently supports flat files, rds files |
... | ... |
@@ -9,7 +9,7 @@ exportSCE( |
9 | 9 |
samplename = "sample", |
10 | 10 |
directory = "./", |
11 | 11 |
type = "Cells", |
12 |
- format = c("R", "Python", "FlatFile", "HTAN") |
|
12 |
+ format = c("SCE", "AnnData", "FlatFile", "HTAN") |
|
13 | 13 |
) |
14 | 14 |
} |
15 | 15 |
\arguments{ |
... | ... |
@@ -26,7 +26,7 @@ and the prefix of flat file output. Default is 'sample'.} |
26 | 26 |
It can be 'Droplets'(raw droplets matrix) or 'Cells' (cells matrix).} |
27 | 27 |
|
28 | 28 |
\item{format}{The format of output. It currently supports flat files, rds files |
29 |
-and python h5 files. It can output multiple formats. Default: c('R', 'Python', 'Flatfile').} |
|
29 |
+and python h5 files. It can output multiple formats. Default: c("SCE", "AnnData", "FlatFile", "HTAN").} |
|
30 | 30 |
} |
31 | 31 |
\description{ |
32 | 32 |
Export data in SingleCellExperiment object |
1 | 1 |
new file mode 100644 |
... | ... |
@@ -0,0 +1,33 @@ |
1 |
+% Generated by roxygen2: do not edit by hand |
|
2 |
+% Please edit documentation in R/sctkQCUtils.R |
|
3 |
+\name{exportSCE} |
|
4 |
+\alias{exportSCE} |
|
5 |
+\title{Export data in SingleCellExperiment object} |
|
6 |
+\usage{ |
|
7 |
+exportSCE( |
|
8 |
+ inSCE, |
|
9 |
+ samplename = "sample", |
|
10 |
+ directory = "./", |
|
11 |
+ type = "Cells", |
|
12 |
+ format = c("R", "Python", "FlatFile") |
|
13 |
+) |
|
14 |
+} |
|
15 |
+\arguments{ |
|
16 |
+\item{inSCE}{A \link[SingleCellExperiment]{SingleCellExperiment} object |
|
17 |
+that contains the data. QC metrics are stored in colData of the |
|
18 |
+singleCellExperiment object.} |
|
19 |
+ |
|
20 |
+\item{samplename}{Sample name. This will be used as name of subdirectories |
|
21 |
+and the prefix of flat file output. Default is 'sample'.} |
|
22 |
+ |
|
23 |
+\item{directory}{Output directory. Default is './'.} |
|
24 |
+ |
|
25 |
+\item{type}{Type of data. The type of data stored in SingleCellExperiment object. |
|
26 |
+It can be 'Droplets'(raw droplets matrix) or 'Cells' (cells matrix).} |
|
27 |
+ |
|
28 |
+\item{format}{The format of output. It currently supports flat files, rds files |
|
29 |
+and python h5 files. It can output multiple formats. Default: c('R', 'Python', 'Flatfile').} |
|
30 |
+} |
|
31 |
+\description{ |
|
32 |
+Export data in SingleCellExperiment object |
|
33 |
+} |