git-svn-id: file:///home/git/hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks/MineICA@73179 bc3139a8-67e5-0310-9ffc-ced21a209358
1 | 1 |
new file mode 100644 |
... | ... |
@@ -0,0 +1,45 @@ |
1 |
+\name{readA} |
|
2 |
+\alias{readA} |
|
3 |
+\title{read A} |
|
4 |
+\usage{ |
|
5 |
+ readA(Afile, datfile, dat, annot = TRUE) |
|
6 |
+} |
|
7 |
+\arguments{ |
|
8 |
+ \item{Afile}{The file which contains the matrix of sample |
|
9 |
+ contributions. It must be a txt file where the separator |
|
10 |
+ is \code{white space}, that is one or more spaces, tabs, |
|
11 |
+ newlines or carriage returns} |
|
12 |
+ |
|
13 |
+ \item{datfile}{The file which contains the matrix (of |
|
14 |
+ dimension features x samples) based on which the matrix A |
|
15 |
+ was calculated} |
|
16 |
+ |
|
17 |
+ \item{dat}{The data based on which the matrix A was |
|
18 |
+ calculated (features x samples)} |
|
19 |
+ |
|
20 |
+ \item{annot}{TRUE (default) if the Afile contains |
|
21 |
+ rownames of matrix A, FALSE if the rownames has to be |
|
22 |
+ extracted from dat} |
|
23 |
+} |
|
24 |
+\value{ |
|
25 |
+ This function returns a matrix of dimension samples x |
|
26 |
+ components with rownames filled with sample IDs. |
|
27 |
+} |
|
28 |
+\description{ |
|
29 |
+ readA |
|
30 |
+} |
|
31 |
+\details{ |
|
32 |
+ This function reads and annotates matrix A. |
|
33 |
+ |
|
34 |
+ The matrix dat must be the one on which the matrix A was |
|
35 |
+ calculated. It is assumed that the number of components |
|
36 |
+ is lower than the number of samples, the matrix will be |
|
37 |
+ transposed to have dimension 'samples x components' |
|
38 |
+ according to this assumption. If \code{annot} is FALSE, |
|
39 |
+ colnames of dat are used to annotate rownames of A. |
|
40 |
+} |
|
41 |
+\author{ |
|
42 |
+ Anne Biton |
|
43 |
+} |
|
44 |
+\keyword{internal} |
|
45 |
+ |