File: mcxarray.1

package info (click to toggle)
mcl 1%3A04-250-2
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 4,536 kB
  • ctags: 2,427
  • sloc: ansic: 25,766; sh: 3,302; perl: 1,376; makefile: 317
file content (147 lines) | stat: -rw-r--r-- 3,641 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
.\" Copyright (c) 2004 Stijn van Dongen
.TH "mcxarray" 1 "6 Sep 2004" "mcxarray 1\&.004, 04-250" "USER COMMANDS"
.po 2m
.de ZI
.\" Zoem Indent/Itemize macro I.
.br
'in +\\$1
.nr xa 0
.nr xa -\\$1
.nr xb \\$1
.nr xb -\\w'\\$2'
\h'|\\n(xau'\\$2\h'\\n(xbu'\\
..
.de ZJ
.br
.\" Zoem Indent/Itemize macro II.
'in +\\$1
'in +\\$2
.nr xa 0
.nr xa -\\$2
.nr xa -\\w'\\$3'
.nr xb \\$2
\h'|\\n(xau'\\$3\h'\\n(xbu'\\
..
.if n .ll -2m
.am SH
.ie n .in 4m
.el .in 8m
..
.SH NAME
mcxarray \- Transform array data to MCL matrices
.SH SYNOPSIS

\fBmcxarray\fP [options] <array data matrix>

\fBmcxarray\fP
\fB[-o\fP fname (\fIoutput file fname\fP)\fB]\fP
\fB[-co\fP num (\fIcutoff for output values\fP)\fB]\fP
\fB[-gq\fP num (\fIignore input smaller than\fP)\fB]\fP
\fB[-lq\fP num (\fIignore input larger than\fP)\fB]\fP
\fB[-t\fP (\fIwork with the transpose\fP)\fB]\fP
\fB[-ctr\fP num (\fIadd center (for graph-type input)\fP)\fB]\fP
\fB[--ctr\fP (\fIadd center with default value (for graph-type input)\fP)\fB]\fP
\fB[--01\fP (\fIremap output to [0,1] interval\fP)\fB]\fP
\fB[--cosine\fP (\fIuse cosine\fP)\fB]\fP
\fB[--pearson\fP (\fIuse Pearson correlation (default)\fP)\fB]\fP
\fB[-tear\fP num (\fIinflate input columns\fP)\fB]\fP
\fB[-teartp\fP num (\fIinflate tranposed columns\fP)\fB]\fP
\fB[-pi\fP num (\fIinflate the result\fP)\fB]\fP
<fname> (\fIarray data matrix\fP)
.SH DESCRIPTION
\fBmcxarray\fP reads a data file satisfying the mcl input format
(refer to \fBmcxio(5)\fP)\&. By default it will work with the
columns as the data vectors (note that mcl matrices are
presented as a listing of columns)\&. This can be changed using
the \fB-t\fP option\&.
.SH OPTIONS

.ZI 3m "\fB-o\fP fname (\fIoutput file fname\fP)"
\&
.br
Indeed\&.
.in -3m

.ZI 3m "\fB-co\fP num (\fIcutoff for output values\fP)"
\&
.br
Output values smaller than \fInum\fP are removed (set to zero)\&.
.in -3m

.ZI 3m "\fB-gq\fP num (\fIignore input smaller than\fP)"
\&
.br
Input values smaller than \fInum\fP are ignored\&.
.in -3m

.ZI 3m "\fB-lq\fP num (\fIignore input larger than\fP)"
\&
.br
Input values larger than \fInum\fP are ignored\&.
.in -3m

.ZI 3m "\fB-t\fP (\fIwork with the transpose\fP)"
\&
.br
Work with the transpose of the input data matrix\&.
.in -3m

.ZI 3m "\fB-ctr\fP num (\fIadd center (for graph-type input)\fP)"
\&
.br
Add diagonal values to the output according to a (so called)
\fIcenter\fP formula\&.
.in -3m

.ZI 3m "\fB--ctr\fP (\fIadd center with default value (for graph-type input)\fP)"
\&
.br
Same as \fB-ctr\fP\ \fB1\&.0\fP\&.
.in -3m

.ZI 3m "\fB--01\fP (\fIremap output to [0,1] interval\fP)"
\&
.br
Rescale output values so that they are within the [0,1] interval\&.
.in -3m

.ZI 3m "\fB--cosine\fP (\fIuse cosine\fP)"
\&
.br
Use the cosine as correlation measure\&.
.in -3m

.ZI 3m "\fB--pearson\fP (\fIuse Pearson correlation (default)\fP)"
\&
.br
Compute the Pearson correleation coefficient as the
similarity between the data columns\&.
.in -3m

.ZI 3m "\fB-tear\fP num (\fIinflate input columns\fP)"
\&
.br
Apply (column-wise) inflation with parameter \fInum\fP to the input
values before further processing\&.
.in -3m

.ZI 3m "\fB-teartp\fP num (\fIinflate tranposed columns\fP)"
\&
.br
Apply (column-wise) inflation with parameter \fInum\fP to the input
values in the transposed matrix before further processing\&.
.in -3m

.ZI 3m "\fB-pi\fP num (\fIinflate the result\fP)"
\&
.br
Apply inflation with parameter \fInum\fP to the output values\&.
.in -3m
.SH AUTHOR

Stijn van Dongen\&.
.SH SEE ALSO
\fBmcl\fP,
\fBmclfaq\fP,
and \fBmclfamily(7)\fP for an overview of all the documentation
and the utilities in the mcl family\&.