-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathusingDendroscope.html
222 lines (217 loc) · 17.5 KB
/
usingDendroscope.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
<h1 id="using-dendroscope">Using Dendroscope</h1>
<h2 id="introduction">Introduction</h2>
<p>Dendroscope is a phylogenetic tree viewer. Thus, it is not designed to estimate trees, or to alter/edit the topologies of already-estimated trees.</p>
<p>The software can <a href="http://www-ab.informatik.uni-tuebingen.de/software/dendroscope/welcome.html">be downloaded from</a> the University of Tuebingen, Germany, where it is developed. The software is available for all three major operating systems. For more information, check out the <a href="http://www.biomedcentral.com/1471-2105/8/460">2007</a> and <a href="http://sysbio.oxfordjournals.org/content/early/2012/09/24/sysbio.sys062">2012</a> articles describing the software.</p>
<h2 id="file-formats-accepted-by-dendroscope">File formats accepted by Dendroscope</h2>
<h3 id="newickphylip-format">NEWICK/PHYLIP format</h3>
<p>Dendroscope can display trees where edges are labeled using square brackets i.e. [...]. For example, the following tree has the label "mammals" attached to the internal branch grouping the mouse and human OTUs</p>
<p><code>((human,mouse)[mammals],frog);</code></p>
<p>Indeed, after adding labels to branches of a tree using Dendroscope, the software uses square brackets in exactly this way if you export the tree in NEWICK format.</p>
<p>However, Dendroscope <strong>cannot display trees where the implicit branch ancestral to the root</strong> is labeled in this way. For example, the following tree would not open in Dendroscope, due to the [tetrapods] label at the root.</p>
<p><code>((human,mouse)[mammals],frog)[tetrapods];</code></p>
<p>Therefore, NEWICK format trees imported from other sources may need to be edited before they can be viewed in Dendroscope - for example, trees exported from TreeFam have the root labeled in this way - this must be removed before the tree is examined in Dendroscope.</p>
<h4 id="example-files">Example files</h4>
<h5 id="newick-format">NEWICK format</h5>
<p><a href="./trees/TF105137_seed_DendroscopeExample.ph">This is an example of a NEWICK format file</a> that can be read by Dendroscope. The tree was obtained from TreeFam (and edited as described above to be readable by Dendroscope)</p>
<p><a href="./trees/TF105088_full_large800plusLeavesEd.ph">This is an example of a large NEWICK format file</a>, with more than 800 terminal nodes. It too was retrieved and slightly modified from TreeFam.</p>
<h5 id="dendroscope-format">Dendroscope format</h5>
<p>After making changes to the way a tree is represented in Dendroscope, you can save a file in native Dendroscope format. When opened by Dendroscope, this file will show the same tree that you saved with the same formating etc. as when you saved it.</p>
<p><a href="./trees/TF105137_seed_ExampleDendroFormat.dendro">This is an example of a Dendroscope format file.</a></p>
<h2 id="dendroscope-graphical-user-interface-gui">Dendroscope Graphical User Interface (GUI)</h2>
<p>The graphical user interface (GUI) for Dendroscope should look similar to the image shown below. The following components of the GUI are labeled</p>
<ul class="incremental">
<li>the Main Window - where the phylogeny/tree is viewed</li>
<li>the Menu Bar - providing a range of different options to manipulate the view of the phylogeny</li>
<li>the Side Bar - provides a list of all the trees present in the current file</li>
<li>the Toolbar - provides short-cuts to several of the more commonly-used menu items</li>
<li>Context Menus - right mouse-click on different regions of the screen to obtain additional options applied to the selected region</li>
<li>nodes</li>
<li>edges</li>
<li>background (allows selection of all edges/nodes/labels)</li>
</ul>
<p><strong>Note: The above description was for a version before the November 2013 release; while similar, the November 2013 release doesn't include the side bar, but adds an additional "messages" window that provides information on the commands issued by us to Dendroscope</strong></p>
<div class="figure">
<img src="./images/basicDendroscopeMainWindowScreenshot.jpg" alt="" />
</div>
<h3 id="opening-a-file">Opening a File</h3>
<p>There is more than one way to open a file<br />
- <em>File -> Open</em> - Use the "Open Tree File" icon <img src="./images/openTreeFileIcon.gif" alt="" /></p>
<p>and then select file to be opened using you operating system's menus</p>
<p><strong>Note: in the November 2013 version, I am unable to open any tree file that does not have the name ending ".txt"; thus, if trying to load a tree from a file with a different name ending, rename (or make a new copy of) the file to add ".txt" to the end of it e.g. if your file is named "TF105137_seed_DendroscopeExample.ph" you could rename it to "TF105137_seed_DendroscopeExample.ph.txt" and Dendroscope should be able to load it</strong></p>
<h3 id="displaying-taxa-labels---important">Displaying Taxa Labels - IMPORTANT!</h3>
<p>To help present a large phylogeny in an uncluttered way, by default Dendroscope chooses to hide from view many of the taxa labels on a tree (where the labels would be overlapping and thus difficult to read) - this is controlled by the option:<br />
<em>View -> Sparse Labels</em></p>
<p>However, if you are searching for a taxon-label corresponding to a particular sequence of interest, this can be problematic: the label you are looking for may have been hidden by Dendroscope.</p>
<p>Therefore, you will often want to switch off this option by simply selecting the <em>View -> Sparse Labels</em> option (if there is a tick after the option, then labels are being hidden)</p>
<p><strong>Note: Above instructions still work for November 2013 version</strong></p>
<h3 id="switching-between-different-tree-representations">Switching Between Different Tree Representations</h3>
<p>There are two ways of doing this:</p>
<ul class="incremental">
<li>Choosing the appropriate "Tree Representation" icon from the toolbar <img src="./images/treeRepresentationIcons.gif" alt="" /><br />
<strong>Note: This still works for November 2013 version</strong></li>
<li>Use the Tree menu<br />
<strong>Note: In November 2013 version, these are now in the "Layout" rather than the "Tree" menu</strong></li>
</ul>
<h5 id="rooted-scaled-tree-representation">Rooted, scaled tree representation</h5>
<p>To view a tree so that it is shown with a root, and with branch-length information <strong>included</strong> in the representation, do one of the following: - <em>Tree -> Draw Rectangular Phylogram</em> (i.e. using the "Tree" menu) - Choose the <img src="./images/drawRectangularPhylogramIcon.gif" alt="" /> Toolbar icon</p>
<h5 id="rooted-unscaled-tree-representation">Rooted, unscaled tree representation</h5>
<p>This is the default representation on some versions of Dendroscope. To view a tree so that it is shown with a root, but with branch-length information ignored in the representation, do the following:</p>
<ul class="incremental">
<li><em>Tree -> Draw Rectangular Cladogram</em> (i.e. using the "Tree" menu)</li>
<li>Choose the <img src="./images/drawRectangularCladogramIcon.gif" alt="" /> Toolbar icon</li>
</ul>
<h5 id="typical-unrooted-representation">"Typical" unrooted representation</h5>
<ul class="incremental">
<li><em>Tree -> Draw Radial Phylogram</em> (i.e. using the "Tree" menu)</li>
<li>Choose the <img src="./images/drawRadialPhylogeramIcon.gif" alt="" /> Toolbar icon</li>
</ul>
<h3 id="selecting-branchesnodes">Selecting Branches/Nodes</h3>
<p>Depending on the number of left mouse-clicks you give to a branch/node you can select</p>
<ul class="incremental">
<li>one click - only the clicked-on branch</li>
<li>two clicks - the entire clan/subtree associated with one end of the branch (including branches, nodes, and labels)</li>
<li>three clicks - the entire clan/subtree associated with the other end of the branch (including branches, nodes, and labels)</li>
</ul>
<p>Multiple branches/nodes/labels can be selected/de-selected by left mouse-clicking while holding the SHIFT key. The image below shows several branches, nodes, and labels highlighted.</p>
<p><strong>Note: In November 2013 version, these instructions are still valid, although they seem to be somewhat erratic i.e. I may have to try 10 times before the double or triple click does what I want</strong></p>
<div class="figure">
<img src="./images/dendroscopeTreeWithSelectedBranchesNodesLabels.gif" alt="" />
</div>
<h3 id="reroot-tree">Reroot Tree</h3>
<p>Left-click with the mouse on the <strong>branch</strong> or <strong>node</strong> you want to place the root on to select it and then either:</p>
<ul class="incremental">
<li>Select the "Reroot tree" Toolbar icon <img src="./images/rerootTreeIcon.gif" alt="" /></li>
<li><em>Edit -> Reroot</em></li>
<li><em>Shift - Control (or cmd on Mac) - R</em></li>
</ul>
<p><strong>Note: This still works for November 2013 version</strong></p>
<h3 id="rotate-branches-around-a-node">Rotate Branches Around a Node</h3>
<p>To rotate branches (which does not change the topology of the tree, only the way it is represented)</p>
<p>Left-click with the mouse on the <strong>node</strong> (doesn't work i.e. won't let you choose to "Swap Subtree etc. if you select a branch instead of a node!) you want to rotate around to select it and then either:</p>
<ul class="incremental">
<li>Select the "Swap order of subtrees below node" Toolbar icon <img src="./images/swapOrderOfSubtreesIcon.jpg" alt="" /></li>
<li><em>Edit -> Swap Subtree</em></li>
<li>Right-click to obtain the node Context Menu and choose <em>"Swap Subtree"</em></li>
<li><em>Control (or cmd on Mac) - T</em></li>
</ul>
<p><strong>Note: This still works for November 2013 version</strong></p>
<h3 id="formatting-branches-and-nodes">Formatting Branches and Nodes</h3>
<p>To change the colour/thickness/font etc. of selected nodes/branches/labels do:</p>
<ul class="incremental">
<li><em>Edit -> Format</em></li>
<li><em>Control (or cmd on Mac) - J</em></li>
</ul>
<p>This brings up the "Format" window shown below</p>
<div class="figure">
<img src="./images/FormatWindow.gif" alt="" />
</div>
<p>From here you can, for example:</p>
<ul class="incremental">
<li>change the width of branches by altering the "Edge Width"</li>
<li>change the colour of the selected nodes/branches/labels by clicking on the colour pallet to choose the appropriate colour</li>
<li>change the size of the text used for the labels using the middle-top menu-box (above this contains the number "10")</li>
</ul>
<p>See the image below for an example of such editing.</p>
<p><strong>Note: This still works for November 2013 version</strong></p>
<div class="figure">
<img src="./images/formatChangesDendroscope.gif" alt="" />
</div>
<h3 id="adding-labels-to-branches">Adding Labels to Branches</h3>
<p>It is possible to add text-labels to branches - for example to supply the name of a clade - e.g. vertebrates - associated with a particular group:</p>
<ul class="incremental">
<li>Select branch(es) of interest</li>
<li>Right-click to get access to the Branch Context Menu
<ul class="incremental">
<li><strong>Note: In November 2013 version this this also works with left-click and Ctrl</strong></li>
</ul></li>
<li>Choose "Edit Edge Label" to provide a text-label for the branch - any gaps in your text will be substituted by "_" characters on the label</li>
</ul>
<p>For example, the image below has a label added to the thick yellow branch.</p>
<div class="figure">
<img src="./images/dendroscopeTreeForStudentsToCopy.gif" alt="" />
</div>
<h3 id="adjusting-positions-of-labels">Adjusting Positions of Labels</h3>
<p>By simply left-clicking with the mouse and dragging it is possible to change the position of any of the labels (either branch labels as above, or the taxa labels at the end of branches. These labels remain attached to their branches and will move accordingly following rearrangements of the tree.</p>
<p><strong>Note: This still works for November 2013 version</strong></p>
<h3 id="adding-a-scale-bar">Adding a scale bar</h3>
<p>Using a "text" command:</p>
<ul class="incremental">
<li>Window -> Execute Command
<ul class="incremental">
<li><strong>Note: in November 2013 version this is Window -> Command input</strong></li>
</ul></li>
<li>Type "set scalebar=true" and press Return</li>
<li>Click "Apply"</li>
</ul>
<p>Using a menu item:</p>
<ul class="incremental">
<li><em>View -> Show scale bar</em>
<ul class="incremental">
<li><strong>Note: This seems to be an addition for November 2013 or some other version more recent than the one these instructions were originally written for</strong></li>
</ul></li>
</ul>
<h3 id="saving-a-tree-representation">Saving a Tree Representation</h3>
<p>You can save the representation of your tree in a format that is read only by Dendroscope - this file can be reloaded into Dendroscope at a later date, and will have exactly the same set of rearrangements and formating as the trees in Dendroscope when the file was saved. You can do this using either of:</p>
<ul class="incremental">
<li><em>File -> Save</em></li>
<li><em>File -> Save As...</em></li>
</ul>
<p>If you are looking to save the image for use in preparing a figure, then use <em>File -> Export Image</em> and save the file in either EPS or SVG format (to maintain it as a set of vectors rather than reducing it to a set of pixels as the other formats do)</p>
<p>The resulting file can then be loaded into a range of different software such as Adobe Illustrator to prepare a file version of a figure for publication/presentation.</p>
<p><strong>Note: This still works for November 2013 version</strong></p>
<h3 id="hiding-branchedge-annotationslabels">Hiding Branch/Edge Annotations/Labels</h3>
<p>Trees obtained from some sources, such as <a href="http://www.treefam.org/">TreeFam</a>, have information annotated/associated with tree branches that can sometimes make the shape, and other features, of the tree difficult to read/interpret. Thus, if we're not interested in reading this information, we usually turn off the representation of this information using the "View" menu:</p>
<ul class="incremental">
<li>View -> Hide Edge Labels</li>
</ul>
<p><strong>Note: for November 2013 version, you need to firstly select (e.g. with <em>Ctrl (or cmd on mac) - A</em> or <em>Select -> Select all</em>) the branches/edges you want to remove labels from, and then uncheck </strong><em>View -> Show edge labels</em>** **</p>
<p>Below is an example of a tree with edge labels shown</p>
<div class="figure">
<img src="./images/treeFamTreeWithEdgeLabelsShown.gif" title="Dendroscope with edge labels shown" alt="Dendroscope with edge labels shown" />
<p class="caption">Dendroscope with edge labels shown</p>
</div>
<p>And here with the labels hidden - this makes the tree topology and other features of the tree much easier to read/identify</p>
<div class="figure">
<img src="./images/treeFamTreeWithEdgeLabelsHidden.gif" title="Dendroscope with edge labels hidden" alt="Dendroscope with edge labels hidden" />
<p class="caption">Dendroscope with edge labels hidden</p>
</div>
<h3 id="changing-angle-of-branches-in-unrooted-tree-representation">Changing angle of branches in unrooted tree representation</h3>
<p><strong>Note: This </strong><em>does not seem to work</em>** for November 2013 version**</p>
<p>To change the angle at which branches are drawn in the typical unrooted tree representation:</p>
<ul class="incremental">
<li><a href="#unrootedRepresentation">switch to this representation</a></li>
</ul>
<div class="figure">
<img src="./images/unrootedTreeNoChangeNoSelection.gif" title="Unrooted tree" alt="Unrooted tree" />
<p class="caption">Unrooted tree</p>
</div>
<ul class="incremental">
<li><a href="#Selecting_BranchesNodes">select the subtree you want to change</a></li>
</ul>
<div class="figure">
<img src="./images/unrootedTreeNoChangeSubtreeSelected.gif" title="Unrooted tree, subtree selected" alt="Unrooted tree, subtree selected" />
<p class="caption">Unrooted tree, subtree selected</p>
</div>
<ul class="incremental">
<li>click and hold down cmd on the region of the subtree to be moved, and then drag the mouse to get the representation you want</li>
</ul>
<div class="figure">
<img src="./images/unrootedTreeAngleChangedSubtreeSelected.gif" title="Unrooted tree, subtree selected, angle changed" alt="Unrooted tree, subtree selected, angle changed" />
<p class="caption">Unrooted tree, subtree selected, angle changed</p>
</div>
<h3 id="using-the-magnifier-to-examine-large-trees">Using the Magnifier to Examine Large Trees</h3>
<p><strong>Note: This still works for November 2013 version</strong></p>
<ul class="incremental">
<li>Switch on the magnifier by clicking on this icon <img src="./images/magnifierIcon.gif" title="Magnifier icon" alt="Magnifier icon" /></li>
<li>Drag the green diamond, top right of the magnifier, to use the magnifier over only a small region of the tree</li>
<li>Click the "+" sign on the top left of the green magnifier to zoom into the tree in this region</li>
</ul>
<h3 id="finding-and-highlighting-labels-matching-a-string">Finding and Highlighting Labels Matching a String</h3>
<ul class="incremental">
<li><em>Edit -> Find/Replace</em></li>
<li>Add substring to search with to "Text to Find" box</li>
<li>Choose "Find All"</li>
<li>Without doing any other action in Dendroscope, do <em>Edit -> Format</em> to <a href="#Formating_Branches_and_Nodes">change the representation of the labels matching the search term</a>, e.g. make the text a different colour and size</li>
</ul>
<hr />
<p>Author: Aidan Budd</p>