JAL-3224 JAL-3225 Fixed help image mangling, moved help to help/help and added this...
[jalview.git] / help / help / html / calculations / sorting.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>Sorting Sequences</title>
24 </head>
25 <body>
26   <p>
27     <strong>Sorting Sequences</strong>
28   </p>
29   <p>
30     Any group of selected sequences may be reordered by pressing the up
31     or down arrow keys. The whole alignment may also be reordered by the
32     use of the functions in the Sort menu (<strong>Calculate&#8594;Sort</strong>):
33   </p>
34   <ul>
35     <li><p>
36         <strong>Sort by ID</strong>
37       </p>
38       <p>Orders the sequences by the alphanumeric (0-9A-Za-z)
39         precedence of their names.</p>
40       <p></li>
41     <li><p>
42         <strong>Sort by Group</strong>
43       </p>
44       <p>Places sequences in the same group adjacent to each other.</p>
45       <p></li>
46     <li><p>
47         <strong>Sort by Pairwise Identity</strong>
48       </p>
49       <p>Sorts sequences in the selection or alignment according to percent identity with respect to the first sequence in the view.</p>
50       <p></li>
51     <li><p>
52         <strong>Sort by Tree Order</strong>
53       </p>
54       <p>
55         The leaf ordering of a particular phylogenetic tree is used to
56         order the sequences corresponding to those leaves in the
57         alignment.<br> If a tree has been calculated from or
58         associated with the current alignment, its name will appear in
59         the submenu <strong>Sort&#8594;By Tree Order</strong>.
60       </p>
61       <p></li>
62     <li><p>
63         <strong>Sort by alignment ordering</strong>
64       </p>
65       <p>
66         Multiple alignment methods often order the sequences in their
67         alignments by some measure of sequence identity.<br> If the
68         current alignment has been generated by one of Jalview's
69         alignment web services, the alignment ordering can be recovered
70         by its corresponding entry in the Sort menu.
71       </p></li>
72     <li><p>
73         <strong>Sort by Score</strong>
74       </p>
75       <p>
76         This menu appears if the alignment contains any <a
77           href="../features/annotationsFormat.html">sequence
78           associated alignment annotation</a> with associated score values.
79         Each entry is the label for a distinct group of sequence
80         associated annotation scores which can be used for sorting.
81       </p>
82   </ul>
83   <p>
84     <strong>Sorting according to sequence features</strong><br />
85     Additional sort operations for alignments containing sequence
86     features are provided in the <strong><a
87       href="../features/featuresettings.html#sortbyfeature">Feature
88         Settings</a></strong> dialog, opened via <strong>View&#8594;Feature
89       Settings...</strong>
90   <p>
91     <strong>Reversing the Order</strong>
92   </p>
93   <p>Selecting any item from the Sort menu will sort sequences in an
94     ascending order according to the property defining the sort. If the
95     same sort is re-applied, the sequences will be sorted in the inverse
96     order. In both cases, for sequences which are equivalent under the
97     sort operation, their order will be preserved (since version 2.10).
98     In the case of trees and alignment orderings, Jalview will remember
99     your last choice for sorting the alignment and only apply the
100     inverse ordering if you select the same tree or alignment ordering
101     item again.</p>
102
103 </body>
104 </html>