Browse code

Add runnable examples

Yichen Wang authored on 02/03/2022 17:35:42
Showing 1 changed files
... ...
@@ -19,3 +19,7 @@ Specified data item.
19 19
 expData
20 20
 Get data item from an input \code{SingleCellExperiment} object. The data item can be an \code{assay}, \code{altExp} (subset) or a \code{reducedDim}, which is retrieved based on the name of the data item.
21 21
 }
22
+\examples{
23
+data(scExample, package = "singleCellTK")
24
+mat <- expData(sce, "counts")
25
+}
Browse code

Fixed some biocCheck issues

Irzam Sarfraz authored on 09/05/2021 12:22:39
Showing 1 changed files
... ...
@@ -12,6 +12,9 @@ expData(inSCE, assayName)
12 12
 
13 13
 \item{assayName}{Specify the name of the data item to retrieve.}
14 14
 }
15
+\value{
16
+Specified data item.
17
+}
15 18
 \description{
16 19
 expData
17 20
 Get data item from an input \code{SingleCellExperiment} object. The data item can be an \code{assay}, \code{altExp} (subset) or a \code{reducedDim}, which is retrieved based on the name of the data item.
Browse code

Final updates to tagging system

Irzam Sarfraz authored on 25/02/2021 00:13:12
Showing 1 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,18 @@
1
+% Generated by roxygen2: do not edit by hand
2
+% Please edit documentation in R/sctkTagging.R
3
+\name{expData}
4
+\alias{expData}
5
+\title{expData
6
+Get data item from an input \code{SingleCellExperiment} object. The data item can be an \code{assay}, \code{altExp} (subset) or a \code{reducedDim}, which is retrieved based on the name of the data item.}
7
+\usage{
8
+expData(inSCE, assayName)
9
+}
10
+\arguments{
11
+\item{inSCE}{Input \code{SingleCellExperiment} object.}
12
+
13
+\item{assayName}{Specify the name of the data item to retrieve.}
14
+}
15
+\description{
16
+expData
17
+Get data item from an input \code{SingleCellExperiment} object. The data item can be an \code{assay}, \code{altExp} (subset) or a \code{reducedDim}, which is retrieved based on the name of the data item.
18
+}