JAL-2189 JAL-1369 JAL-192 expand referenceseq documentation
[jalview.git] / help / html / calculations / referenceseq.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>Reference Sequences</title>
24 </head>
25 <body>
26   <p>
27     <strong>Reference Sequence Alignment Views</strong>
28   </p>
29   <p>Many alignment analysis tasks concern a query, or reference
30     sequence. For instance, when searching for sequences from other
31     organisms that are similar to a newly sequenced gene, or when
32     searching for structurally similar sequences for use in homology
33     modelling.</p>
34 <p>
35     <strong>What happens when a reference sequence is defined ?</strong>
36   </p>
37   <p>
38     The reference sequence for an alignment is indicated by its ID being
39     shown in bold. In addition:</p>
40   <ul>
41     <li><strong>Reference sequence numbering</strong>. Instead of
42       column numbers, the alignment ruler shows the reference sequence
43       positions at each column. At each tick mark, either the reference
44       sequence symbol and position is given, or the column number when a
45       gap is present at that position in the reference sequence.</li>
46     <li><strong>Format&#8594;Show unconserved</strong> highlights
47       mutations with respect to the reference sequence, rather than the
48       alignment's consensus sequence.</li>
49   </ul>
50   <p>
51     <strong>Defining the reference sequence</strong>
52   </p>
53   <p>Each alignment view can have its own reference sequence.</p>
54   <ul>
55     <li><strong>Manually assigning a reference sequence</strong><br />
56       A sequence can be marked as the reference sequence by
57       right-clicking on its ID to open the popup menu, and selecting the
58       "<strong>(Sequence ID)&#8594;Mark as Reference</strong>" entry.</li>
59     <li><strong>Defining a reference when importing
60         annotation</strong><br />Jalview automatically assigns a reference
61       sequence when importing analysis results, such as those returned
62       from <a href="../webServices/jnet.html">JPred4</a> . A reference
63       sequence can also be assigned via the <a
64       href="../features/annotationsFormat.html#refsandviews">SET_REF</a> command in
65       an alignment annotation file.</li>
66   </ul>
67   <p>
68     <em>Reference sequence based alignment visualisation was
69       introduced in Jalview 2.9, and support for storage and retrieval
70       of reference sequence views in 2.10.</em>
71   </p>
72 </html>