Add missing binaty and statis library
[jabaws.git] / binaries / src / ViennaRNA / Cluster / AnalyseDists.1
1 .TH ANALYSEDISTS l
2 .ER
3 .SH NAME
4 AnalyseDists \- Analyse a distance matrix 
5 .SH SYNOPSIS
6 \fBAnalyseDists [\-X[\fIswn\fP]]
7 .SH DESCRIPTION
8 .I AnalyseDists
9 reads a distance matrix (given as lower triangle matrix)
10 from stdin and writes a split decomposition and a cluster 
11 analysis of this distance matrix to stdout.
12 The line before the distance matrix must be of the form
13 .br
14 > Y x [comments]
15 .br
16 where 'x' gives the number of taxa, 'Y' is a single character that
17 indicates the type of distance and 'comment' is an arbitrary comment.
18 This matches the output format of, e.g., RNAdistance. 
19 The input data file may contain arbitrary lines before and after the 
20 distance matrix. All lines beginning with '> ' that are not of the 
21 above form are written to stdout. The programm continues reading
22 until it encounters an EOF condition or the terminator character '@'.
23 .br
24 A list of taxa names can be specified in the input stream. The list 
25 must begin with a line of the form
26 .br
27 * [fname]
28 .br
29 if fname is present, it will be used to name the postscript output files.
30 The entries have the form 'x : Taxon',
31 where x is the number of taxon, i.e., the corresponding row and column
32 of the distance matrix. The taxa list need not be complete. It must
33 end however with a line beginning with '*' or any of the separator
34 characters. The taxa list is printed on top of the output.
35
36 .SH OPTIONS
37
38 .IP \fB\-X[swn]\fI\fP
39 specifies the analysis methods to be used. 
40 .IP \fB[s]\fI\fP 
41 Split decomposition.
42 .IP \fB[w]\fI\fP 
43 Cluster analysis using Ward's method. A PostScript file named '[fname_]wards.ps'
44 is created containing a drawing of the tree.
45 .IP \fB[n]\fI\fP
46 Cluster analysis using Saitou's neighbour joining method.
47 A PostScript file named '[fname_]nj.ps' is created containing a drawing of the tree.
48
49 .SH REFERENCES
50
51 The method of split decomposition was proposed by H.J. Bandelt and
52 A.W.M. Dress (Adv Math, 92:1992,47).
53 .br
54 The variance method for cluster analysis is due to H.J. Ward. 
55 (J Amer Stat Ass, 58:1963,236).
56 .br
57 The neighbour joining method was published by Saitou and Nei
58 (Mol Biol Evol, 4:1987,406).  
59 .br
60 This program is part of the Vienna RNA Package.
61
62 .SH WARNING
63 This a beta test version.
64
65 .SH VERSION
66 This man page is part of the Vienna RNA Package version 1.2
67 .SH AUTHOR
68 Peter F Stadler and Ivo L Hofacker.
69 .SH BUGS
70 Comments should be sent to ivo@tbi.univie.ac.at.
71 .br