Mac binaries
[jabaws.git] / website / archive / binaries / mac / src / clustalw / clustalw_help
1
2
3
4  CLUSTAL 2.0.12 Multiple Sequence Alignments
5
6
7
8
9 >> HELP NEW <<             NEW FEATURES/OPTIONS
10
11 ==UPGMA== 
12  The UPGMA algorithm has been added to allow faster tree construction. The user now
13  has the choice of using Neighbour Joining or UPGMA. The default is still NJ, but the
14  user can change this by setting the clustering parameter.
15  
16  -CLUSTERING=   :NJ or UPGMA
17  
18 ==ITERATION==
19
20  A remove first iteration scheme has been added. This can be used to improve the final
21  alignment or improve the alignment at each stage of the progressive alignment. During the 
22  iteration step each sequence is removed in turn and realigned. If the resulting alignment 
23  is better than the  previous alignment it is kept. This process is repeated until the score
24  converges (the  score is not improved) or until the maximum number of iterations is 
25  reached. The user can  iterate at each step of the progressive alignment by setting the 
26  iteration parameter to  TREE or just on the final alignment by seting the iteration 
27  parameter to ALIGNMENT. The default is no iteration. The maximum number of  iterations can 
28  be set using the numiter parameter. The default number of iterations is 3.
29   
30  -ITERATION=    :NONE or TREE or ALIGNMENT
31  
32  -NUMITER=n     :Maximum number of iterations to perform
33  
34 ==HELP==
35  
36  -FULLHELP      :Print out the complete help content
37  
38 ==MISC==
39
40  -MAXSEQLEN=n   :Maximum allowed sequence length
41  
42  -QUIET         :Reduce console output to minimum
43  
44  -STATS=file    :Log some alignents statistics to file
45
46
47 >> HELP 1 <<             General help for CLUSTAL W (2.0.12)
48
49 Clustal W is a general purpose multiple alignment program for DNA or proteins.
50
51 SEQUENCE INPUT:  all sequences must be in 1 file, one after another.  
52 7 formats are automatically recognised: NBRF-PIR, EMBL-SWISSPROT, 
53 Pearson (Fasta), Clustal (*.aln), GCG-MSF (Pileup), GCG9-RSF and GDE flat file.
54 All non-alphabetic characters (spaces, digits, punctuation marks) are ignored
55 except "-" which is used to indicate a GAP ("." in MSF-RSF).  
56
57 To do a MULTIPLE ALIGNMENT on a set of sequences, use item 1 from this menu to 
58 INPUT them; go to menu item 2 to do the multiple alignment.
59
60 PROFILE ALIGNMENTS (menu item 3) are used to align 2 alignments.  Use this to
61 add a new sequence to an old alignment, or to use secondary structure to guide 
62 the alignment process.  GAPS in the old alignments are indicated using the "-" 
63 character.   PROFILES can be input in ANY of the allowed formats; just 
64 use "-" (or "." for MSF-RSF) for each gap position.
65
66 PHYLOGENETIC TREES (menu item 4) can be calculated from old alignments (read in
67 with "-" characters to indicate gaps) OR after a multiple alignment while the 
68 alignment is still in memory.
69
70
71 The program tries to automatically recognise the different file formats used
72 and to guess whether the sequences are amino acid or nucleotide.  This is not
73 always foolproof.
74
75 FASTA and NBRF-PIR formats are recognised by having a ">" as the first 
76 character in the file.  
77
78 EMBL-Swiss Prot formats are recognised by the letters
79 ID at the start of the file (the token for the entry name field).  
80
81 CLUSTAL format is recognised by the word CLUSTAL at the beginning of the file.
82
83 GCG-MSF format is recognised by one of the following:
84        - the word PileUp at the start of the file. 
85        - the word !!AA_MULTIPLE_ALIGNMENT or !!NA_MULTIPLE_ALIGNMENT
86          at the start of the file.
87        - the word MSF on the first line of the line, and the characters ..
88          at the end of this line.
89
90 GCG-RSF format is recognised by the word !!RICH_SEQUENCE at the beginning of
91 the file.
92
93
94 If 85% or more of the characters in the sequence are from A,C,G,T,U or N, the
95 sequence will be assumed to be nucleotide.  This works in 97.3% of cases
96 but watch out!
97
98
99 >> HELP 2 <<             Help for multiple alignments
100
101 If you have already loaded sequences, use menu item 1 to do the complete
102 multiple alignment.  You will be prompted for 2 output files: 1 for the 
103 alignment itself; another to store a dendrogram that describes the similarity
104 of the sequences to each other.
105
106 Multiple alignments are carried out in 3 stages (automatically done from menu
107 item 1 ...Do complete multiple alignments now):
108
109 1) all sequences are compared to each other (pairwise alignments);
110
111 2) a dendrogram (like a phylogenetic tree) is constructed, describing the
112 approximate groupings of the sequences by similarity (stored in a file).
113
114 3) the final multiple alignment is carried out, using the dendrogram as a guide.
115
116
117 PAIRWISE ALIGNMENT parameters control the speed-sensitivity of the initial
118 alignments.
119
120 MULTIPLE ALIGNMENT parameters control the gaps in the final multiple alignments.
121
122
123 RESET GAPS (menu item 7) will remove any new gaps introduced into the sequences
124 during multiple alignment if you wish to change the parameters and try again.
125 This only takes effect just before you do a second multiple alignment.  You
126 can make phylogenetic trees after alignment whether or not this is ON.
127 If you turn this OFF, the new gaps are kept even if you do a second multiple
128 alignment. This allows you to iterate the alignment gradually.  Sometimes, the 
129 alignment is improved by a second or third pass.
130
131 SCREEN DISPLAY (menu item 8) can be used to send the output alignments to the 
132 screen as well as to the output file.
133
134 You can skip the first stages (pairwise alignments; dendrogram) by using an
135 old dendrogram file (menu item 3); or you can just produce the dendrogram
136 with no final multiple alignment (menu item 2).
137
138
139 OUTPUT FORMAT: Menu item 9 (format options) allows you to choose from 6 
140 different alignment formats (CLUSTAL, GCG, NBRF-PIR, PHYLIP, GDE, NEXUS, and FASTA).  
141
142
143
144 >> HELP 3 <<             Help for pairwise alignment parameters
145
146 A distance is calculated between every pair of sequences and these are used to
147 construct the dendrogram which guides the final multiple alignment. The scores
148 are calculated from separate pairwise alignments. These can be calculated using
149 2 methods: dynamic programming (slow but accurate) or by the method of Wilbur
150 and Lipman (extremely fast but approximate). 
151
152 You can choose between the 2 alignment methods using menu option 8.  The
153 slow-accurate method is fine for short sequences but will be VERY SLOW for 
154 many (e.g. >100) long (e.g. >1000 residue) sequences.   
155
156 SLOW-ACCURATE alignment parameters:
157         These parameters do not have any affect on the speed of the alignments. 
158 They are used to give initial alignments which are then rescored to give percent
159 identity scores.  These % scores are the ones which are displayed on the 
160 screen.  The scores are converted to distances for the trees.
161
162 1) Gap Open Penalty:      the penalty for opening a gap in the alignment.
163 2) Gap extension penalty: the penalty for extending a gap by 1 residue.
164 3) Protein weight matrix: the scoring table which describes the similarity
165                           of each amino acid to each other.
166 4) DNA weight matrix:     the scores assigned to matches and mismatches 
167                           (including IUB ambiguity codes).
168
169
170 FAST-APPROXIMATE alignment parameters:
171
172 These similarity scores are calculated from fast, approximate, global align-
173 ments, which are controlled by 4 parameters.   2 techniques are used to make
174 these alignments very fast: 1) only exactly matching fragments (k-tuples) are
175 considered; 2) only the 'best' diagonals (the ones with most k-tuple matches)
176 are used.
177
178 K-TUPLE SIZE:  This is the size of exactly matching fragment that is used. 
179 INCREASE for speed (max= 2 for proteins; 4 for DNA), DECREASE for sensitivity.
180 For longer sequences (e.g. >1000 residues) you may need to increase the default.
181
182 GAP PENALTY:   This is a penalty for each gap in the fast alignments.  It has
183 little affect on the speed or sensitivity except for extreme values.
184
185 TOP DIAGONALS: The number of k-tuple matches on each diagonal (in an imaginary
186 dot-matrix plot) is calculated.  Only the best ones (with most matches) are
187 used in the alignment.  This parameter specifies how many.  Decrease for speed;
188 increase for sensitivity.
189
190 WINDOW SIZE:  This is the number of diagonals around each of the 'best' 
191 diagonals that will be used.  Decrease for speed; increase for sensitivity.
192
193
194 >> HELP 4 <<             Help for multiple alignment parameters
195
196 These parameters control the final multiple alignment. This is the core of the
197 program and the details are complicated. To fully understand the use of the
198 parameters and the scoring system, you will have to refer to the documentation.
199
200 Each step in the final multiple alignment consists of aligning two alignments 
201 or sequences.  This is done progressively, following the branching order in 
202 the GUIDE TREE.  The basic parameters to control this are two gap penalties and
203 the scores for various identical-non-indentical residues.  
204
205 1) and 2) The GAP PENALTIES are set by menu items 1 and 2. These control the 
206 cost of opening up every new gap and the cost of every item in a gap. 
207 Increasing the gap opening penalty will make gaps less frequent. Increasing 
208 the gap extension penalty will make gaps shorter. Terminal gaps are not 
209 penalised.
210
211 3) The DELAY DIVERGENT SEQUENCES switch delays the alignment of the most
212 distantly related sequences until after the most closely related sequences have 
213 been aligned.   The setting shows the percent identity level required to delay
214 the addition of a sequence; sequences that are less identical than this level
215 to any other sequences will be aligned later.
216
217
218
219 4) The TRANSITION WEIGHT gives transitions (A <--> G or C <--> T 
220 i.e. purine-purine or pyrimidine-pyrimidine substitutions) a weight between 0
221 and 1; a weight of zero means that the transitions are scored as mismatches,
222 while a weight of 1 gives the transitions the match score. For distantly related
223 DNA sequences, the weight should be near to zero; for closely related sequences
224 it can be useful to assign a higher score.
225
226
227 5) PROTEIN WEIGHT MATRIX leads to a new menu where you are offered a choice of
228 weight matrices. The default for proteins in version 1.8 is the PAM series 
229 derived by Gonnet and colleagues. Note, a series is used! The actual matrix
230 that is used depends on how similar the sequences to be aligned at this 
231 alignment step are. Different matrices work differently at each evolutionary
232 distance. 
233
234 6) DNA WEIGHT MATRIX leads to a new menu where a single matrix (not a series)
235 can be selected. The default is the matrix used by BESTFIT for comparison of
236 nucleic acid sequences.
237
238 Further help is offered in the weight matrix menu.
239
240
241 7)  In the weight matrices, you can use negative as well as positive values if
242 you wish, although the matrix will be automatically adjusted to all positive
243 scores, unless the NEGATIVE MATRIX option is selected.
244
245 8) PROTEIN GAP PARAMETERS displays a menu allowing you to set some Gap Penalty
246 options which are only used in protein alignments.
247
248
249 >> HELP A <<             Help for protein gap parameters.
250
251 1) RESIDUE SPECIFIC PENALTIES are amino acid specific gap penalties that reduce
252 or increase the gap opening penalties at each position in the alignment or
253 sequence.  See the documentation for details.  As an example, positions that 
254 are rich in glycine are more likely to have an adjacent gap than positions that
255 are rich in valine.
256
257 2) 3) HYDROPHILIC GAP PENALTIES are used to increase the chances of a gap within
258 a run (5 or more residues) of hydrophilic amino acids; these are likely to
259 be loop or random coil regions where gaps are more common.  The residues that 
260 are "considered" to be hydrophilic are set by menu item 3.
261
262 4) GAP SEPARATION DISTANCE tries to decrease the chances of gaps being too
263 close to each other. Gaps that are less than this distance apart are penalised
264 more than other gaps. This does not prevent close gaps; it makes them less
265 frequent, promoting a block-like appearance of the alignment.
266
267 5) END GAP SEPARATION treats end gaps just like internal gaps for the purposes
268 of avoiding gaps that are too close (set by GAP SEPARATION DISTANCE above).
269 If you turn this off, end gaps will be ignored for this purpose.  This is
270 useful when you wish to align fragments where the end gaps are not biologically
271 meaningful.
272
273
274 >> HELP 5 <<             Help for output format options.
275
276 Six output formats are offered. You can choose any (or all 6 if you wish).  
277
278 CLUSTAL format output is a self explanatory alignment format.  It shows the
279 sequences aligned in blocks.  It can be read in again at a later date to
280 (for example) calculate a phylogenetic tree or add a new sequence with a 
281 profile alignment.
282
283 GCG output can be used by any of the GCG programs that can work on multiple
284 alignments (e.g. PRETTY, PROFILEMAKE, PLOTALIGN).  It is the same as the GCG
285 .msf format files (multiple sequence file); new in version 7 of GCG.
286
287 PHYLIP format output can be used for input to the PHYLIP package of Joe 
288 Felsenstein.  This is an extremely widely used package for doing every 
289 imaginable form of phylogenetic analysis (MUCH more than the the modest intro-
290 duction offered by this program).
291
292 NBRF-PIR:  this is the same as the standard PIR format with ONE ADDITION.  Gap
293 characters "-" are used to indicate the positions of gaps in the multiple 
294 alignment.  These files can be re-used as input in any part of clustal that
295 allows sequences (or alignments or profiles) to be read in.  
296
297 GDE:  this is the flat file format used by the GDE package of Steven Smith.
298
299 NEXUS: the format used by several phylogeny programs, including PAUP and
300 MacClade.
301
302 GDE OUTPUT CASE: sequences in GDE format may be written in either upper or
303 lower case.
304
305 CLUSTALW SEQUENCE NUMBERS: residue numbers may be added to the end of the
306 alignment lines in clustalw format.
307
308 OUTPUT ORDER is used to control the order of the sequences in the output
309 alignments.  By default, the order corresponds to the order in which the
310 sequences were aligned (from the guide tree-dendrogram), thus automatically
311 grouping closely related sequences. This switch can be used to set the order
312 to the same as the input file.
313
314 PARAMETER OUTPUT: This option allows you to save all your parameter settings
315 in a parameter file. This file can be used subsequently to rerun Clustal W
316 using the same parameters.
317
318
319 >> HELP 6 <<             Help for profile and structure alignments
320
321 By PROFILE ALIGNMENT, we mean alignment using existing alignments. Profile 
322 alignments allow you to store alignments of your favourite sequences and add
323 new sequences to them in small bunches at a time. A profile is simply an
324 alignment of one or more sequences (e.g. an alignment output file from CLUSTAL
325 W). Each input can be a single sequence. One or both sets of input sequences
326 may include secondary structure assignments or gap penalty masks to guide the
327 alignment. 
328
329 The profiles can be in any of the allowed input formats with "-" characters
330 used to specify gaps (except for MSF-RSF where "." is used).
331
332 You have to specify the 2 profiles by choosing menu items 1 and 2 and giving
333 2 file names.  Then Menu item 3 will align the 2 profiles to each other. 
334 Secondary structure masks in either profile can be used to guide the alignment.
335
336 Menu item 4 will take the sequences in the second profile and align them to
337 the first profile, 1 at a time.  This is useful to add some new sequences to
338 an existing alignment, or to align a set of sequences to a known structure.  
339 In this case, the second profile would not be pre-aligned.
340
341
342 The alignment parameters can be set using menu items 5, 6 and 7. These are
343 EXACTLY the same parameters as used by the general, automatic multiple
344 alignment procedure. The general multiple alignment procedure is simply a
345 series of profile alignments. Carrying out a series of profile alignments on
346 larger and larger groups of sequences, allows you to manually build up a
347 complete alignment, if necessary editing intermediate alignments.
348
349 SECONDARY STRUCTURE OPTIONS. Menu Option 0 allows you to set 2D structure
350 parameters. If a solved structure is available, it can be used to guide the 
351 alignment by raising gap penalties within secondary structure elements, so 
352 that gaps will preferentially be inserted into unstructured surface loops.
353 Alternatively, a user-specified gap penalty mask can be supplied directly.
354
355 A gap penalty mask is a series of numbers between 1 and 9, one per position in 
356 the alignment. Each number specifies how much the gap opening penalty is to be 
357 raised at that position (raised by multiplying the basic gap opening penalty
358 by the number) i.e. a mask figure of 1 at a position means no change
359 in gap opening penalty; a figure of 4 means that the gap opening penalty is
360 four times greater at that position, making gaps 4 times harder to open.
361
362 The format for gap penalty masks and secondary structure masks is explained
363 in the help under option 0 (secondary structure options).
364
365
366 >> HELP B <<             Help for secondary structure - gap penalty masks
367
368 The use of secondary structure-based penalties has been shown to improve the
369 accuracy of multiple alignment. Therefore CLUSTAL W now allows gap penalty 
370 masks to be supplied with the input sequences. The masks work by raising gap 
371 penalties in specified regions (typically secondary structure elements) so that
372 gaps are preferentially opened in the less well conserved regions (typically 
373 surface loops).
374
375 Options 1 and 2 control whether the input secondary structure information or
376 gap penalty masks will be used.
377
378 Option 3 controls whether the secondary structure and gap penalty masks should
379 be included in the output alignment.
380
381 Options 4 and 5 provide the value for raising the gap penalty at core Alpha 
382 Helical (A) and Beta Strand (B) residues. In CLUSTAL format, capital residues 
383 denote the A and B core structure notation. The basic gap penalties are
384 multiplied by the amount specified.
385
386 Option 6 provides the value for the gap penalty in Loops. By default this 
387 penalty is not raised. In CLUSTAL format, loops are specified by "." in the 
388 secondary structure notation.
389
390 Option 7 provides the value for setting the gap penalty at the ends of 
391 secondary structures. Ends of secondary structures are observed to grow 
392 and-or shrink in related structures. Therefore by default these are given 
393 intermediate values, lower than the core penalties. All secondary structure 
394 read in as lower case in CLUSTAL format gets the reduced terminal penalty.
395
396 Options 8 and 9 specify the range of structure termini for the intermediate 
397 penalties. In the alignment output, these are indicated as lower case. 
398 For Alpha Helices, by default, the range spans the end helical turn. For 
399 Beta Strands, the default range spans the end residue and the adjacent loop 
400 residue, since sequence conservation often extends beyond the actual H-bonded
401 Beta Strand.
402
403 CLUSTAL W can read the masks from SWISS-PROT, CLUSTAL or GDE format input
404 files. For many 3-D protein structures, secondary structure information is
405 recorded in the feature tables of SWISS-PROT database entries. You should
406 always check that the assignments are correct - some are quite inaccurate.
407 CLUSTAL W looks for SWISS-PROT HELIX and STRAND assignments e.g.
408
409 FT   HELIX       100    115
410 FT   STRAND      118    119
411
412 The structure and penalty masks can also be read from CLUSTAL alignment format 
413 as comment lines beginning "!SS_" or "!GM_" e.g.
414
415 !SS_HBA_HUMA    ..aaaAAAAAAAAAAaaa.aaaAAAAAAAAAAaaaaaaAaaa.........aaaAAAAAA
416 !GM_HBA_HUMA    112224444444444222122244444444442222224222111111111222444444
417 HBA_HUMA        VLSPADKTNVKAAWGKVGAHAGEYGAEALERMFLSFPTTKTYFPHFDLSHGSAQVKGHGK
418
419 Note that the mask itself is a set of numbers between 1 and 9 each of which is 
420 assigned to the residue(s) in the same column below. 
421
422 In GDE flat file format, the masks are specified as text and the names must
423 begin with "SS_ or "GM_.
424
425 Either a structure or penalty mask or both may be used. If both are included in
426 an alignment, the user will be asked which is to be used.
427
428
429 >> HELP C <<             Help for secondary structure - gap penalty mask output options
430
431 The options in this menu let you choose whether or not to include the masks
432 in the CLUSTAL W output alignments. Showing both is useful for understanding
433 how the masks work. The secondary structure information is itself very useful
434 in judging the alignment quality and in seeing how residue conservation
435 patterns vary with secondary structure.
436
437
438 >> HELP 7 <<             Help for phylogenetic trees
439
440 1) Before calculating a tree, you must have an ALIGNMENT in memory. This can be
441 input in any format or you should have just carried out a full multiple
442 alignment and the alignment is still in memory. 
443
444
445 *************** Remember YOU MUST ALIGN THE SEQUENCES FIRST!!!! ***************
446
447
448 The methods used are NJ (Neighbour Joining) and UPGMA. First
449 you calculate distances (percent divergence) between all pairs of sequence from
450 a multiple alignment; second you apply the NJ or UPGMA method to the distance matrix.
451
452 2) EXCLUDE POSITIONS WITH GAPS? With this option, any alignment positions where
453 ANY of the sequences have a gap will be ignored. This means that 'like' will be
454 compared to 'like' in all distances, which is highly desirable. It also
455 automatically throws away the most ambiguous parts of the alignment, which are
456 concentrated around gaps (usually). The disadvantage is that you may throw away
457 much of the data if there are many gaps (which is why it is difficult for us to
458 make it the default).  
459
460
461
462 3) CORRECT FOR MULTIPLE SUBSTITUTIONS? For small divergence (say <10%) this
463 option makes no difference. For greater divergence, it corrects for the fact
464 that observed distances underestimate actual evolutionary distances. This is
465 because, as sequences diverge, more than one substitution will happen at many
466 sites. However, you only see one difference when you look at the present day
467 sequences. Therefore, this option has the effect of stretching branch lengths
468 in trees (especially long branches). The corrections used here (for DNA or
469 proteins) are both due to Motoo Kimura. See the documentation for details.  
470
471 Where possible, this option should be used. However, for VERY divergent
472 sequences, the distances cannot be reliably corrected. You will be warned if
473 this happens. Even if none of the distances in a data set exceed the reliable
474 threshold, if you bootstrap the data, some of the bootstrap distances may
475 randomly exceed the safe limit.  
476
477 4) To calculate a tree, use option 4 (DRAW TREE NOW). This gives an UNROOTED
478 tree and all branch lengths. The root of the tree can only be inferred by
479 using an outgroup (a sequence that you are certain branches at the outside
480 of the tree .... certain on biological grounds) OR if you assume a degree
481 of constancy in the 'molecular clock', you can place the root in the 'middle'
482 of the tree (roughly equidistant from all tips).
483
484 5) TOGGLE PHYLIP BOOTSTRAP POSITIONS
485 By default, the bootstrap values are correctly placed on the tree branches of
486 the phylip format output tree. The toggle allows them to be placed on the
487 nodes, which is incorrect, but some display packages (e.g. TreeTool, TreeView
488 and Phylowin) only support node labelling but not branch labelling. Care
489 should be taken to note which branches and labels go together.
490
491 6) OUTPUT FORMATS: four different formats are allowed. None of these displays
492 the tree visually. Useful display programs accepting PHYLIP format include
493 NJplot (from Manolo Gouy and supplied with Clustal W), TreeView (Mac-PC), and
494 PHYLIP itself - OR get the PHYLIP package and use the tree drawing facilities
495 there. (Get the PHYLIP package anyway if you are interested in trees). The
496 NEXUS format can be read into PAUP or MacClade.
497
498
499 >> HELP 8 <<             Help for choosing a weight matrix
500
501 For protein alignments, you use a weight matrix to determine the similarity of
502 non-identical amino acids.  For example, Tyr aligned with Phe is usually judged 
503 to be 'better' than Tyr aligned with Pro.
504
505 There are three 'in-built' series of weight matrices offered. Each consists of
506 several matrices which work differently at different evolutionary distances. To
507 see the exact details, read the documentation. Crudely, we store several
508 matrices in memory, spanning the full range of amino acid distance (from almost
509 identical sequences to highly divergent ones). For very similar sequences, it
510 is best to use a strict weight matrix which only gives a high score to
511 identities and the most favoured conservative substitutions. For more divergent
512 sequences, it is appropriate to use "softer" matrices which give a high score
513 to many other frequent substitutions.
514
515 1) BLOSUM (Henikoff). These matrices appear to be the best available for 
516 carrying out database similarity (homology searches). The matrices used are:
517 Blosum 80, 62, 45 and 30. (BLOSUM was the default in earlier Clustal W
518 versions)
519
520 2) PAM (Dayhoff). These have been extremely widely used since the late '70s.
521 We use the PAM 20, 60, 120 and 350 matrices.
522
523 3) GONNET. These matrices were derived using almost the same procedure as the
524 Dayhoff one (above) but are much more up to date and are based on a far larger
525 data set. They appear to be more sensitive than the Dayhoff series. We use the
526 GONNET 80, 120, 160, 250 and 350 matrices. This series is the default for
527 Clustal W version 1.8.
528
529 We also supply an identity matrix which gives a score of 1.0 to two identical 
530 amino acids and a score of zero otherwise. This matrix is not very useful.
531 Alternatively, you can read in your own (just one matrix, not a series).
532
533 A new matrix can be read from a file on disk, if the filename consists only
534 of lower case characters. The values in the new weight matrix must be integers
535 and the scores should be similarities. You can use negative as well as positive
536 values if you wish, although the matrix will be automatically adjusted to all
537 positive scores.
538
539
540
541 For DNA, a single matrix (not a series) is used. Two hard-coded matrices are 
542 available:
543
544
545 1) IUB. This is the default scoring matrix used by BESTFIT for the comparison
546 of nucleic acid sequences. X's and N's are treated as matches to any IUB
547 ambiguity symbol. All matches score 1.9; all mismatches for IUB symbols score 0.
548  
549  
550 2) CLUSTALW(1.6). The previous system used by Clustal W, in which matches score
551 1.0 and mismatches score 0. All matches for IUB symbols also score 0.
552
553 INPUT FORMAT  The format used for a new matrix is the same as the BLAST program.
554 Any lines beginning with a # character are assumed to be comments. The first
555 non-comment line should contain a list of amino acids in any order, using the
556 1 letter code, followed by a * character. This should be followed by a square
557 matrix of integer scores, with one row and one column for each amino acid. The
558 last row and column of the matrix (corresponding to the * character) contain
559 the minimum score over the whole matrix.
560
561
562 >> HELP 9 <<             Help for command line parameters
563
564                 DATA (sequences)
565
566 -INFILE=file.ext                             :input sequences.
567 -PROFILE1=file.ext  and  -PROFILE2=file.ext  :profiles (old alignment).
568
569
570                 VERBS (do things)
571
572 -OPTIONS            :list the command line parameters
573 -HELP  or -CHECK    :outline the command line params.
574 -FULLHELP           :output full help content.
575 -ALIGN              :do full multiple alignment.
576 -TREE               :calculate NJ tree.
577 -PIM                :output percent identity matrix (while calculating the tree)
578 -BOOTSTRAP(=n)      :bootstrap a NJ tree (n= number of bootstraps; def. = 1000).
579 -CONVERT            :output the input sequences in a different file format.
580
581
582                 PARAMETERS (set things)
583
584 ***General settings:****
585 -INTERACTIVE :read command line, then enter normal interactive menus
586 -QUICKTREE   :use FAST algorithm for the alignment guide tree
587 -TYPE=       :PROTEIN or DNA sequences
588 -NEGATIVE    :protein alignment with negative values in matrix
589 -OUTFILE=    :sequence alignment file name
590 -OUTPUT=     :GCG, GDE, PHYLIP, PIR or NEXUS
591 -OUTORDER=   :INPUT or ALIGNED
592 -CASE        :LOWER or UPPER (for GDE output only)
593 -SEQNOS=     :OFF or ON (for Clustal output only)
594 -SEQNO_RANGE=:OFF or ON (NEW: for all output formats)
595 -RANGE=m,n   :sequence range to write starting m to m+n
596 -MAXSEQLEN=n :maximum allowed input sequence length
597 -QUIET       :Reduce console output to minimum
598 -STATS=      :Log some alignents statistics to file
599
600 ***Fast Pairwise Alignments:***
601 -KTUPLE=n    :word size
602 -TOPDIAGS=n  :number of best diags.
603 -WINDOW=n    :window around best diags.
604 -PAIRGAP=n   :gap penalty
605 -SCORE       :PERCENT or ABSOLUTE
606
607
608 ***Slow Pairwise Alignments:***
609 -PWMATRIX=    :Protein weight matrix=BLOSUM, PAM, GONNET, ID or filename
610 -PWDNAMATRIX= :DNA weight matrix=IUB, CLUSTALW or filename
611 -PWGAPOPEN=f  :gap opening penalty        
612 -PWGAPEXT=f   :gap opening penalty
613
614
615 ***Multiple Alignments:***
616 -NEWTREE=      :file for new guide tree
617 -USETREE=      :file for old guide tree
618 -MATRIX=       :Protein weight matrix=BLOSUM, PAM, GONNET, ID or filename
619 -DNAMATRIX=    :DNA weight matrix=IUB, CLUSTALW or filename
620 -GAPOPEN=f     :gap opening penalty        
621 -GAPEXT=f      :gap extension penalty
622 -ENDGAPS       :no end gap separation pen. 
623 -GAPDIST=n     :gap separation pen. range
624 -NOPGAP        :residue-specific gaps off  
625 -NOHGAP        :hydrophilic gaps off
626 -HGAPRESIDUES= :list hydrophilic res.    
627 -MAXDIV=n      :% ident. for delay
628 -TYPE=         :PROTEIN or DNA
629 -TRANSWEIGHT=f :transitions weighting
630 -ITERATION=    :NONE or TREE or ALIGNMENT
631 -NUMITER=n     :maximum number of iterations to perform
632 -NOWEIGHTS     :disable sequence weighting
633
634
635 ***Profile Alignments:***
636 -PROFILE      :Merge two alignments by profile alignment
637 -NEWTREE1=    :file for new guide tree for profile1
638 -NEWTREE2=    :file for new guide tree for profile2
639 -USETREE1=    :file for old guide tree for profile1
640 -USETREE2=    :file for old guide tree for profile2
641
642
643 ***Sequence to Profile Alignments:***
644 -SEQUENCES   :Sequentially add profile2 sequences to profile1 alignment
645 -NEWTREE=    :file for new guide tree
646 -USETREE=    :file for old guide tree
647
648
649 ***Structure Alignments:***
650 -NOSECSTR1     :do not use secondary structure-gap penalty mask for profile 1 
651 -NOSECSTR2     :do not use secondary structure-gap penalty mask for profile 2
652 -SECSTROUT=STRUCTURE or MASK or BOTH or NONE   :output in alignment file
653 -HELIXGAP=n    :gap penalty for helix core residues 
654 -STRANDGAP=n   :gap penalty for strand core residues
655 -LOOPGAP=n     :gap penalty for loop regions
656 -TERMINALGAP=n :gap penalty for structure termini
657 -HELIXENDIN=n  :number of residues inside helix to be treated as terminal
658 -HELIXENDOUT=n :number of residues outside helix to be treated as terminal
659 -STRANDENDIN=n :number of residues inside strand to be treated as terminal
660 -STRANDENDOUT=n:number of residues outside strand to be treated as terminal 
661
662
663 ***Trees:***
664 -OUTPUTTREE=nj OR phylip OR dist OR nexus
665 -SEED=n        :seed number for bootstraps.
666 -KIMURA        :use Kimura's correction.   
667 -TOSSGAPS      :ignore positions with gaps.
668 -BOOTLABELS=node OR branch :position of bootstrap values in tree display
669 -CLUSTERING=   :NJ or UPGMA
670
671
672 >> HELP 0 <<             Help for tree output format options
673
674 Four output formats are offered: 1) Clustal, 2) Phylip, 3) Just the distances
675 4) Nexus
676
677 None of these formats displays the results graphically. Many packages can
678 display trees in the the PHYLIP format 2) below. It can also be imported into
679 the PHYLIP programs RETREE, DRAWTREE and DRAWGRAM for graphical display. 
680 NEXUS format trees can be read by PAUP and MacClade.
681
682 1) Clustal format output. 
683 This format is verbose and lists all of the distances between the sequences and
684 the number of alignment positions used for each. The tree is described at the
685 end of the file. It lists the sequences that are joined at each alignment step
686 and the branch lengths. After two sequences are joined, it is referred to later
687 as a NODE. The number of a NODE is the number of the lowest sequence in that
688 NODE.   
689
690 2) Phylip format output.
691 This format is the New Hampshire format, used by many phylogenetic analysis
692 packages. It consists of a series of nested parentheses, describing the
693 branching order, with the sequence names and branch lengths. It can be used by
694 the RETREE, DRAWGRAM and DRAWTREE programs of the PHYLIP package to see the
695 trees graphically. This is the same format used during multiple alignment for
696 the guide trees. 
697
698 Use this format with NJplot (Manolo Gouy), supplied with Clustal W. Some other
699 packages that can read and display New Hampshire format are TreeView (Mac/PC),
700 TreeTool (UNIX), and Phylowin.
701
702 3) The distances only.
703 This format just outputs a matrix of all the pairwise distances in a format
704 that can be used by the Phylip package. It used to be useful when one could not
705 produce distances from protein sequences in the Phylip package but is now
706 redundant (Protdist of Phylip 3.5 now does this).
707
708 4) NEXUS FORMAT TREE. This format is used by several popular phylogeny programs,
709 including PAUP and MacClade. The format is described fully in:
710 Maddison, D. R., D. L. Swofford and W. P. Maddison.  1997.
711 NEXUS: an extensible file format for systematic information.
712 Systematic Biology 46:590-621.
713
714 5) TOGGLE PHYLIP BOOTSTRAP POSITIONS
715 By default, the bootstrap values are placed on the nodes of the phylip format
716 output tree. This is inaccurate as the bootstrap values should be associated
717 with the tree branches and not the nodes. However, this format can be read and
718 displayed by TreeTool, TreeView and Phylowin. An option is available to
719 correctly place the bootstrap values on the branches with which they are
720 associated.