JAL-2392 formatting
[jalview.git] / 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>Places pairs of sequences together that align with the
50         greatest fraction of conserved residues.</p>
51       <p></li>
52     <li><p>
53         <strong>Sort by Tree Order</strong>
54       </p>
55       <p>
56         The leaf ordering of a particular phylogenetic tree is used to
57         order the sequences corresponding to those leaves in the
58         alignment.<br> If a tree has been calculated from or
59         associated with the current alignment, its name will appear in
60         the submenu <strong>Sort&#8594;By Tree Order</strong>.
61       </p>
62       <p></li>
63     <li><p>
64         <strong>Sort by alignment ordering</strong>
65       </p>
66       <p>
67         Multiple alignment methods often order the sequences in their
68         alignments by some measure of sequence identity.<br> If the
69         current alignment has been generated by one of Jalview's
70         alignment web services, the alignment ordering can be recovered
71         by its corresponding entry in the Sort menu.
72       </p></li>
73     <li><p>
74         <strong>Sort by Score</strong>
75       </p>
76       <p>
77         This menu appears if the alignment contains any <a
78           href="../features/annotationsFormat.html">sequence
79           associated alignment annotation</a> with associated score values.
80         Each entry is the label for a distinct group of sequence
81         associated annotation scores which can be used for sorting.
82       </p>
83   </ul>
84   <p>
85     <strong>Sorting according to sequence features</strong><br />
86     Additional sort operations for alignments containing sequence
87     features are provided in the <strong><a
88       href="../features/featuresettings.html#sortbyfeature">Feature
89         Settings</a></strong> dialog, opened via <strong>View&#8594;Feature
90       Settings...</strong>
91   <p>
92     <strong>Reversing the Order</strong>
93   </p>
94   <p>Selecting any item from the Sort menu will sort sequences in an
95     ascending order according to the property defining the sort. If the
96     same sort is re-applied, the sequences will be sorted in the inverse
97     order. In both cases, for sequences which are equivalent under the
98     sort operation, their order will be preserved (since version 2.10).
99     In the case of trees and alignment orderings, Jalview will remember
100     your last choice for sorting the alignment and only apply the
101     inverse ordering if you select the same tree or alignment ordering
102     item again.</p>
103
104 </body>
105 </html>