2.5.1 release branding
[jalview.git] / help / html / calculations / treeviewer.html
1 #-------------------------------------------------------------------------------
2 # Jalview - A Sequence Alignment Editor and Viewer (Version 2.5.1)
3 # Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
4
5 # This file is part of Jalview.
6
7 # Jalview is free software: you can redistribute it and/or
8 # modify it under the terms of the GNU General Public License 
9 # as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
10
11 # Jalview is distributed in the hope that it will be useful, but 
12 # WITHOUT ANY WARRANTY; without even the implied warranty 
13 # of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
14 # PURPOSE.  See the GNU General Public License for more details.
15
16 # You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
17 #-------------------------------------------------------------------------------
18 <html>
19 <!--
20  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)
21  * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
22  * 
23  * This file is part of Jalview.
24  * 
25  * Jalview is free software: you can redistribute it and/or
26  * modify it under the terms of the GNU General Public License 
27  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
28  * 
29  * Jalview is distributed in the hope that it will be useful, but 
30  * WITHOUT ANY WARRANTY; without even the implied warranty 
31  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
32  * PURPOSE.  See the GNU General Public License for more details.
33  * 
34  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
35 -->
36 <head>
37 <title>The Tree Viewing Window</title>
38 </head>
39 <body>
40 <p><strong>The Tree Viewing Window</strong></p>
41 <p>
42   The tree viewing window is opened when a tree has been <a href="tree.html">calculated 
43   from an alignment</a>, or imported via a file or web service. It includes <a href="#menus">menus</a> for 
44   controlling layout and file and figure creation, and enables 
45   various selection and colouring operations on the 
46   associated sequences in the alignment.</p>
47 <p>
48 <strong><em>Selecting Sequence Leaf Nodes</em></strong><br>
49   Selecting sequence ids at the leaves of the tree selects the
50   corresponding sequences in the original alignment. These selections
51   are also reflected in any other analysis windows associated with the
52   alignment, such as another tree viewer.</p>
53 <p><strong><em>Grouping sequences by partitioning the tree at a particular distanec</em></strong><br>
54   Clicking anywhere along the extent of the tree (but not on a leaf or
55   internal node) defines a tree 'partition', by cutting every branch
56   of the tree spanning the depth where the mouse-click occurred. Groups
57   are created containing sequences at the leaves of each connected
58   sub tree. These groups are each given a different colour, which are
59   reflected in other windows in the same way as if the sequence ids
60   were selected, and can be edited in the same way as user defined
61   sequence groups.
62 </p>
63 <p>Tree partitions are useful for comparing clusters produced by
64 different methods and measures. They are also an effective way of
65 identifying specific patterns of conservation and mutation
66 corresponding to the overall phylogenetic structure, when combined
67 with the <a href="../colourSchemes/conservation.html">conservation
68 based colour scheme</a>.</p>
69 <p>
70 <strong><em>Selecting Subtrees and changing the branch order and subtree group colour</em></strong><br>
71 Moving the mouse over an internal node of the tree will highlight
72   it. You can then : <ul>
73   <li>Click the highlighted node to select all the sequences in that branch.
74   <li>Double-click the highlighted node to rearrange the tree
75   diagram by inverting the branch ordering at that
76   node.
77   <li>Right-click to open the 'Select Sub-Tree Colour' dialog box, to
78   pick a new colour for the sub-tree and associated sequences.
79   </ul>
80 </p>
81 <p><strong><a name="menus">
82 File Menu</a></strong></p>
83 <p>This menu allows the displayed tree to be saved as a Newick tree
84 file (Save&#8594;Newick File), printed or exported as an image (PNG) or
85 Postscript file. Finally, data used to calculate the tree can be
86 retrieved with the 'Input Data...' entry.
87 </p>
88 <p><strong>View Menu</strong></p>
89 <p>When the tree viewer is opened, it displays all the annotation
90 associated with a tree. Trees calculated by Jalview have branch
91 lengths, which correspond to the distance measure used to construct
92 the tree. Tree imported from outside may also contain bootstrap information,
93 and additional leaves from sequences not present in the associated
94 alignment.
95 </p>
96 <p>The view menu contains options controlling the way a tree is
97 rendered and labelled:
98 <ul>
99 <li><strong>Fit to Window</strong><p>
100 The tree layout will be scaled to fit in the  display
101 window. You may need to reduce the font size to minimise the leaf
102 label overlap when this option is selected.
103 </p></li>
104 <li><strong>Font Size ...</strong><em>n</em><p>
105 Brings up a dialog box to set the font size for the leaf
106 names. <em>n</em> is the current font size.
107 </p></li>
108 <li><strong>Show Distances</strong><p>
109 Labels each branch or leaf with its associated branch
110 length.</p></li>
111 <li><strong>Show Bootstrap values</strong><p>
112 Labels each branch or leaf with its associated bootstrap value.
113 </p></li>
114 <li><strong>Mark unlinked leaves</strong><p>
115 Toggles the display of a '*' at the beginning of a leaf label to
116 indicate that there is no sequence corresponding to that leaf in the
117 associated alignment.
118 </p></li>
119 <li><strong>Associate Leaves with ...</strong><p>
120 Only visible when there are <a href="../features/multipleviews.html">multiple views</a> of the same
121 alignment to show and edit which alignment views are associated with
122 the leaves of the displayed tree.
123 </p>
124 </ul>
125 </p>
126 </body>
127 </html>