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