File: cluster3.sgml

package info (click to toggle)
cluster3 1.59+ds-1
  • links: PTS, VCS
  • area: non-free
  • in suites: sid
  • size: 3,616 kB
  • sloc: ansic: 9,948; python: 2,018; perl: 1,566; makefile: 132
file content (171 lines) | stat: -rw-r--r-- 7,091 bytes parent folder | download | duplicates (4)
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@

    
	The docbook-to-man binary is found in the docbook-to-man package.
	Please remember that if you create the nroff version in one of the
	debian/rules file targets (such as build), you will need to include
	docbook-to-man in your Build-Depends control field.

  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Steffen</firstname>">
  <!ENTITY dhsurname   "<surname>Moeller</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>April  6, 2004</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>moeller@pzr.uni-rostock.de</email>">
  <!ENTITY dhusername  "Steffen Moeller">
  <!ENTITY dhucpackage "<refentrytitle>CLUSTER3</refentrytitle>">
  <!ENTITY dhpackage   "cluster3">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2003</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>Eisen-clustering of microarray data</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>

      <arg><option>-f <replaceable>filename</replaceable></option></arg>
      <arg><option>-l <replaceable>0|1</replaceable></option></arg>
      <arg><option>-u <replaceable>jobname</replaceable></option></arg>
      <arg><option>-g <replaceable>[0..9]</replaceable></option></arg>
      <arg><option>-e <replaceable>[0..9]</replaceable></option></arg>
      <arg><option>-m <replaceable>[msca]</replaceable></option></arg>
      <arg><option>-k <replaceable>number</replaceable></option></arg>
      <arg><option>-s <replaceable>0|1</replaceable></option></arg>
      <arg><option>-x <replaceable>number</replaceable></option></arg>
      <arg><option>-y <replaceable>number</replaceable></option></arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>OPTIONS</title>

    <variablelist>
      <varlistentry><term><option>-h</option><option>--help</option></term><listitem><para>Show summary of options.</para></listitem></varlistentry>
      <varlistentry><term><option>-f <replaceable>filename</replaceable></option></term><listitem><para>file loding</para></listitem></varlistentry>
      <varlistentry><term><option>-u <replaceable>jobname</replaceable></option></term><listitem><para>Allows you to specify a different name for the output files (default is derived from the input file name)</para></listitem></varlistentry>
      <varlistentry><term><option>-l <replaceable>0|1</replaceable></option></term><listitem><para>Specifies whether to log-transform the data (default is 0, no log-transform)</para></listitem></varlistentry>
      <varlistentry><term><option>-k <replaceable>number</replaceable></option></term><listitem><para>Specifies whether to run k-means clustering instead of hierarchical clustering, and the number of clusters k to use (default: 0)</para></listitem></varlistentry>
      <varlistentry><term><option>-x <replaceable>number</replaceable></option></term><listitem><para>Specifies the horizontal dimension of the SOM grid (default: 2)</para></listitem></varlistentry>
      <varlistentry><term><option>-y <replaceable>number</replaceable></option></term><listitem><para>Specifies the vertical dimension of the SOM grid (default: 1)</para></listitem></varlistentry>
      <varlistentry><term><option>-s <replaceable>0|1</replaceable></option></term><listitem><para>Specifies whether to calculate an SOM instead of hierarchical clustering (default: 0)</para></listitem></varlistentry>
      <varlistentry>
        <term><option>-v</option>
          <option>--version</option>
        </term>
        <listitem>
          <para>Show version of program.</para>
        </listitem>
      </varlistentry>
    </variablelist>
<para>
  -g [0..9]     Specifies the distance measure for gene clustering
                0: No gene clustering
                1: Uncentered correlation
                2: Pearson correlation
                3: Uncentered correlation, absolute value
                4: Pearson correlation, absolute value
                5: Spearman's rank correlation
                6: Kendall's tau
                7: Euclidean distance
                8: Harmonically summed Euclidean distance
                9: City-block distance
                (default: 1)</para><para>
  -e [0..9]     Specifies the distance measure for microarray clustering
                0: No clustering
                1: Uncentered correlation
                2: Pearson correlation
                3: Uncentered correlation, absolute value
                4: Pearson correlation, absolute value
                5: Spearman's rank correlation
                6: Kendall's tau
                7: Euclidean distance
                8: Harmonically summed Euclidean distance
                9: City-block distance
                (default: 0)</para><para>
  -m [msca]     Specifies which hierarchical clustering method to use
                m: Pairwise complete-linkage
                s: Pairwise single-linkage
                c: Pairwise centroid-linkage
                a: Pairwise average-linkage
                (default: m)</para>
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>

    <para>mapletree (1), smile (1).</para>

  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; &dhemail; for
      the &debian; system (but may be used by others).  Permission is
      granted to copy, distribute and/or modify this document under
      the terms of the &gnu; General Public License, Version 2 any 
	  later version published by the Free Software Foundation.
    </para>
	<para>
	  On Debian systems, the complete text of the GNU General Public
	  License can be found in /usr/share/common-licenses/GPL.
	</para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->