Anne Biton authored on 23/04/2020 18:30:14
git-svn-id: file:///home/git/hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks/MineICA@73179 bc3139a8-67e5-0310-9ffc-ced21a209358
Marc Carlson authored on 05/02/2013 22:15:53
| 1 | 1 |
new file mode 100644 |
| ... | ... |
@@ -0,0 +1,33 @@ |
| 1 |
+\name{getComp}
|
|
| 2 |
+\alias{getComp}
|
|
| 3 |
+\alias{getComp,IcaSet-method}
|
|
| 4 |
+\alias{getComp,IcaSet,character,numeric}
|
|
| 5 |
+\alias{getComp,IcaSet,character,numeric-method}
|
|
| 6 |
+ |
|
| 7 |
+ |
|
| 8 |
+\title{Retrieve feature and sample values on a component stored in an \code{IcaSet} object.}
|
|
| 9 |
+\description{This generic function retrieves, from an \code{\link{IcaSet}} object,
|
|
| 10 |
+ the feature projections (contained in attribute \code{S}) and
|
|
| 11 |
+ sample contributions (contained in attribute \code{A})
|
|
| 12 |
+ corresponding to a specific component. |
|
| 13 |
+} |
|
| 14 |
+\usage{
|
|
| 15 |
+getComp(object, level, ind) |
|
| 16 |
+} |
|
| 17 |
+\arguments{
|
|
| 18 |
+ \item{object}{Object of class \code{\link{IcaSet}}.}
|
|
| 19 |
+ \item{level}{Either "features" to retrieve projections contained in
|
|
| 20 |
+ \code{S}, or "genes" to retrieve projections contained in
|
|
| 21 |
+ \code{SByGene}.}
|
|
| 22 |
+ \item{ind}{The index of the component to be retrieved.}
|
|
| 23 |
+ |
|
| 24 |
+} |
|
| 25 |
+\value{
|
|
| 26 |
+ \code{getComp} returns a list containing two elements:
|
|
| 27 |
+ \describe{\item{proj:}{the feature or gene
|
|
| 28 |
+ projections on the given component,}\item{contrib:}{the sample
|
|
| 29 |
+ contributions on the given component.}} |
|
| 30 |
+} |
|
| 31 |
+\author{Anne Biton}
|
|
| 32 |
+ |
|
| 33 |
+\seealso{\code{\link{IcaSet-class}}}
|