... | ... |
@@ -1,4 +1,4 @@ |
1 |
-% Generated by roxygen2 (4.1.1): do not edit by hand |
|
1 |
+% Generated by roxygen2: do not edit by hand |
|
2 | 2 |
% Please edit documentation in R/restrictFeatureMat.R |
3 | 3 |
\name{restrictFeatureMat} |
4 | 4 |
\alias{restrictFeatureMat} |
... | ... |
@@ -12,24 +12,22 @@ restrictFeatureMat(geneSet, featureMat, prefixSet = c("cop", "exp", "mut")) |
12 | 12 |
\item{featureMat}{a matrix or data frame with feature vectors along rows and feature |
13 | 13 |
names specified in rownames(featureMat).} |
14 | 14 |
|
15 |
-\item{prefixSet}{a set of feature name prefixes to be prepended to each element of geneSet to |
|
15 |
+\item{prefixSet}{a set of feature name prefixes to be prepended to each element of geneSet to |
|
16 | 16 |
obtain a collection of geneSet-associated features.} |
17 | 17 |
} |
18 | 18 |
\value{ |
19 | 19 |
a matrix containing the features in the intersection of rownames(featureMat) and |
20 |
-the set of geneSet-derived features (obtained by prepending each element of prefixSet to |
|
20 |
+the set of geneSet-derived features (obtained by prepending each element of prefixSet to |
|
21 | 21 |
each gene in geneSet). |
22 | 22 |
|
23 |
-#' |
|
24 |
-} |
|
25 |
-\description{ |
|
26 |
-Restricts a feature matrix to only include features associated with a specified gene set. |
|
27 |
-} |
|
28 |
-\examples{ |
|
23 |
+#' @examples |
|
29 | 24 |
X <- matrix(1:25, nrow=5) |
30 | 25 |
rownames(X) <- c("expA", "expB", "copC", "mutC", "expD") |
31 | 26 |
restrictFeatureMat(geneSet = c("B", "C"), X) |
32 | 27 |
} |
28 |
+\description{ |
|
29 |
+Restricts a feature matrix to only include features associated with a specified gene set. |
|
30 |
+} |
|
33 | 31 |
\concept{ |
34 | 32 |
rcellminer |
35 | 33 |
} |
1 | 1 |
new file mode 100644 |
... | ... |
@@ -0,0 +1,36 @@ |
1 |
+% Generated by roxygen2 (4.1.1): do not edit by hand |
|
2 |
+% Please edit documentation in R/restrictFeatureMat.R |
|
3 |
+\name{restrictFeatureMat} |
|
4 |
+\alias{restrictFeatureMat} |
|
5 |
+\title{Restricts a feature matrix to only include features associated with a specified gene set.} |
|
6 |
+\usage{ |
|
7 |
+restrictFeatureMat(geneSet, featureMat, prefixSet = c("cop", "exp", "mut")) |
|
8 |
+} |
|
9 |
+\arguments{ |
|
10 |
+\item{geneSet}{a character vector of gene names.} |
|
11 |
+ |
|
12 |
+\item{featureMat}{a matrix or data frame with feature vectors along rows and feature |
|
13 |
+names specified in rownames(featureMat).} |
|
14 |
+ |
|
15 |
+\item{prefixSet}{a set of feature name prefixes to be prepended to each element of geneSet to |
|
16 |
+obtain a collection of geneSet-associated features.} |
|
17 |
+} |
|
18 |
+\value{ |
|
19 |
+a matrix containing the features in the intersection of rownames(featureMat) and |
|
20 |
+the set of geneSet-derived features (obtained by prepending each element of prefixSet to |
|
21 |
+each gene in geneSet). |
|
22 |
+ |
|
23 |
+#' |
|
24 |
+} |
|
25 |
+\description{ |
|
26 |
+Restricts a feature matrix to only include features associated with a specified gene set. |
|
27 |
+} |
|
28 |
+\examples{ |
|
29 |
+X <- matrix(1:25, nrow=5) |
|
30 |
+rownames(X) <- c("expA", "expB", "copC", "mutC", "expD") |
|
31 |
+restrictFeatureMat(geneSet = c("B", "C"), X) |
|
32 |
+} |
|
33 |
+\concept{ |
|
34 |
+rcellminer |
|
35 |
+} |
|
36 |
+ |