JAL-3224 JAL-3225 Fixed help image mangling, moved help to help/help and added this...
[jalview.git] / help / help / html / menus / alwcalculate.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>Alignment Window Menus</title>
24 </head>
25
26 <body>
27   <p>
28     <strong>Alignment Window Calculate Menu</strong>
29   </p>
30   <ul>
31     <li><strong>Sort </strong>
32       <ul>
33         <li><strong>By ID</strong><em><br> This will sort
34             the sequences according to sequence name. If the sort is
35             repeated, the order of the sorted sequences will be
36             inverted. </em></li>
37         <li><strong>By Length</strong><em><br> This will
38             sort the sequences according to their length (excluding gap
39             characters). If the sort is repeated, the order of the
40             sorted sequences will be inverted. </em></li>
41         <li><strong>By Group</strong><strong><br> </strong><em>This
42             will sort the sequences according to sequence name. If the
43             sort is repeated, the order of the sorted sequences will be
44             inverted. </em><strong></strong></li>
45         <li><strong>By Pairwise Identity<br>
46         </strong><em>This will sort the selected sequences by their
47             percentage identity to the consensus sequence. The most
48             similar sequence is put at the top. </em></li>
49         <li><em>The <a href="../calculations/sorting.html">Sort
50               menu</a> will have some additional options if the alignment
51             has any associated score annotation, or you have just done a
52             multiple alignment calculation or opened a tree viewer
53             window.
54         </em><br></li>
55       </ul></li>
56     <li><strong>Calculate Tree or PCA ...</strong> <br> <em>Opens the 
57     <a href="../calculations/calculations.html">calculations dialog</a> for
58         for calculating <a href="../calculations/tree.html">trees</a> or
59          <a href="../calculations/pca.html">principle component analysis 
60          plots</a> on the alignment or the currently selected
61         region. 
62       </em><br>
63     </li>
64     <li><strong>Pairwise Alignments</strong><br> <em>Applies
65         Smith and Waterman algorithm to selected sequences. See <a
66         href="../calculations/pairwise.html">pairwise
67           alignments</a>.
68     </em><br></li>
69     <li><strong>Extract Scores ... (optional)</strong><br> <em>This
70         option is only visible if Jalview detects one or more
71         white-space separated values in the description line of the
72         alignment sequences.<br> When selected, these numbers are
73         parsed into sequence associated annotation which can then be
74         used to sort the alignment via the Sort by&#8594;Score menu.
75     </em> <br></li>
76     <li><strong>Translate as cDNA</strong><br> <em>This
77         option is visible for nucleotide alignments. Selecting this
78         option shows the DNA's calculated protein product in a new <a
79         href="../features/splitView.html">split frame</a> window. Note
80         that the translation is not frame- or intron-aware; it simply
81         translates all codons in each sequence. You can use the standard <a
82         href="../misc/geneticCode.html">genetic code</a>, or choose an 
83         alternative code table (any incomplete final codon is discarded). 
84         You can perform this action on the whole alignment, or selected 
85         rows, columns, or regions. Alternative code tables were added in
86         Jalview 2.11.
87     </em> <br></li>
88     <li><strong>Reverse, Reverse Complement</strong> (not applet)<br>
89       <em>These options are visible for nucleotide alignments.
90         Selecting them adds the reverse (or reverse complement) of the
91         sequences (or selected region) as new sequences in the
92         alignment. To try this out, add this sequence and perform
93         'Reverse Complement' followed by 'Translate as cDNA': <br>
94       <small> Seq
95           GTCATTTGCGCGTGTTGATTATTCGGACCGCTCCACTTCCCTTTACTCGTGCGTTCAATTGATTTAATCCTC
96           TGGGGGGGCTCTGGTTTACATAGCTTAAATCTATTCCATTCAAGGAAGCTCATG</small>
97     </em> <br></li>
98     <li><strong>Get Cross-References</strong> (not applet)<br>
99       <em>This option is visible where sequences have
100         cross-references to other standard databases; for example, an
101         EMBL entry may have cross-references to one or more UNIPROT
102         entries. Select the database to view all cross-referenced
103         sequences in a new <a href="../features/splitView.html">split
104           frame</a> window.
105     </em> <br></li>
106     <li><strong>Autocalculate Consensus</strong><br> <em>For
107         large alignments it can be useful to deselect
108         &quot;Autocalculate Consensus&quot; when editing. This prevents
109         the sometimes lengthy calculations performed after each sequence
110         edit.</em> <br></li>
111     <li><strong>Sort Alignment With New Tree</strong><br> <em>If
112         this option is selected, the alignment will be automatically
113         sorted whenever a new tree is calculated or loaded.</em> <br></li>
114     <li><strong>Show Flanking Regions</strong><br> <em>Opens
115         a new alignment window showing any additional sequence data
116         either side of the current alignment. Useful in conjunction with
117         'Fetch Database References' when the 'Trim Retrieved Sequences'
118         option is disabled to retrieve full length sequences for a set
119         of aligned peptides. </em></li>
120   </ul>
121 </body>
122 </html>