JAL-2089 patch broken merge to master for Release 2.10.0b1
[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">calculated from an alignment</a>, or
32     imported via a file or web service. It includes <a href="#menus">menus</a>
33     for controlling layout and file and figure creation, and enables
34     various selection and colouring operations on the associated
35     sequences in the alignment.
36   </p>
37   <p>
38     <strong><em>Selecting Sequence Leaf Nodes</em></strong><br>
39     Selecting sequence ids at the leaves of the tree selects the
40     corresponding sequences in the original alignment. These selections
41     are also reflected in any other analysis windows associated with the
42     alignment, such as another tree viewer.
43   </p>
44   <p>
45     <strong><em>Grouping sequences by partitioning the
46         tree at a particular distanec</em></strong><br> Clicking anywhere along
47     the extent of the tree (but not on a leaf or internal node) defines
48     a tree 'partition', by cutting every branch of the tree spanning the
49     depth where the mouse-click occurred. Groups are created containing
50     sequences at the leaves of each connected sub tree. These groups are
51     each given a different colour, which are reflected in other windows
52     in the same way as if the sequence ids were selected, and can be
53     edited in the same way as user defined sequence groups.
54   </p>
55   <p>
56     Tree partitions are useful for comparing clusters produced by
57     different methods and measures. They are also an effective way of
58     identifying specific patterns of conservation and mutation
59     corresponding to the overall phylogenetic structure, when combined
60     with the <a href="../colourSchemes/conservation.html">conservation
61       based colour scheme</a>.
62   </p>
63   <p>
64     <strong><em>Selecting Subtrees and changing the branch
65         order and subtree group colour</em></strong><br> Moving the mouse over an
66     internal node of the tree will highlight it. You can then :
67   <ul>
68     <li>Click the highlighted node to select all the sequences in
69       that branch.
70     <li>Double-click the highlighted node to rearrange the tree
71       diagram by inverting the branch ordering at that node.
72     <li>Right-click to open the 'Select Sub-Tree Colour' dialog
73       box, to pick a new colour for the sub-tree and associated
74       sequences.
75   </ul>
76   </p>
77   <p>
78     <strong><a name="menus"> File Menu</a></strong>
79   </p>
80   <p>This menu allows the displayed tree to be saved as a Newick
81     tree file (Save&#8594;Newick File), printed or exported as an image
82     (PNG) or Postscript file. Finally, data used to calculate the tree
83     can be retrieved with the 'Input Data...' entry.</p>
84   <p>
85     <strong>View Menu</strong>
86   </p>
87   <p>When the tree viewer is opened, it displays all the annotation
88     associated with a tree. Trees calculated by Jalview have branch
89     lengths, which correspond to the distance measure used to construct
90     the tree. Tree imported from outside may also contain bootstrap
91     information, and additional leaves from sequences not present in the
92     associated alignment.</p>
93   <p>The view menu mostly contains options controlling the way a
94     tree is rendered and labeled:
95   <ul>
96     <li><strong>Fit to Window</strong>
97       <p>The tree layout will be scaled to fit in the display
98         window. You may need to reduce the font size to minimise the
99         leaf label overlap when this option is selected.</p></li>
100     <li><strong>Font Size ...</strong><em>n</em>
101       <p>
102         Brings up a dialog box to set the font size for the leaf names.
103         <em>n</em> is the current font size.
104       </p></li>
105     <li><strong>Show Distances</strong>
106       <p>Labels each branch or leaf with its associated branch
107         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
113         label to indicate that there is no sequence corresponding to
114         that leaf 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">multiple
124           views</a> of the same alignment to show and edit which alignment
125         views are associated with the leaves of the displayed tree.
126       </p>
127   </ul>
128   </p>
129 </body>
130 </html>