JAL-2416 score matrix gap symbol (if any) dynamically determined
[jalview.git] / help / html / features / splitView.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>Split Frame Views</title>
24 </head>
25 <body>
26   <p>
27     <strong>Split Frame Views</strong>
28   </p>
29   <p>
30     Jalview provides a special viewing mode to show Coding DNA (cDNA)
31     and protein product alignments as a split view, with cDNA above and
32     protein below. The two alignments are linked, allowing editing and
33     analysis to be performed at both the peptide and nucleotide level.
34     Linked protein alignments also have an additional <strong>cDNA
35       Consensus</strong> annotation row, showing the distribution of codons at
36     each column of the protein alignment.
37   </p>
38   <p>
39     Split Frame views can be <a href="#opensplit">created in a
40       number of ways</a>. In the Jalview Desktop, Split Frame views are
41     saved in Jalview Projects, like any other alignment view.
42   </p>
43   <p>
44     <strong>Operations supported in Split Frame Mode</strong>
45   </p>
46   <p>Split Frame views allow the following:
47   <ul>
48     <li>Mouseover or scrolling of either alignment is followed by
49       the other (unless you turn off <strong><a
50         href="../menus/alwview.html">"View&#8594;Automatic
51           Scrolling"</a></strong>)
52     </li>
53     <li>On selecting rows, columns or regions in one alignment, the
54       corresponding selection is made in the other</li>
55     <li>Sequence ordering in one alignment (using the cursor, or <strong><a
56         href="../calculations/sorting.html">"Calculate&#8594;Sort")</a></strong>
57       is also applied to the other
58     </li>
59     <li>Editing (gap insertion / deletion) in the protein alignment
60       is reflected in the cDNA (but not vice versa)</li>
61     <li>Any trees imported or created with <strong><a
62         href="../calculations/tree.html">"Calculate Tree"</a></strong> on
63       one of the views allow both cDNA and Protein views to be grouped,
64       coloured or sorted.
65     </li>
66     <li>To allow for the different widths in cDNA and Protein
67       alignments, the <strong><a href="../menus/alwformat.html">"Format&#8594;Font"</a></strong>
68       menu option has an option 'Scale protein residues to codons'. This
69       option will make each protein residue the same width as a DNA
70       codon (so the alignments 'line up' vertically)
71     </li>
72     <li><strong>"View&#8594;Protein"</strong> (in the cDNA panel)
73       or <strong>"View&#8594;Nucleotide"</strong> (in the protein panel)
74       allows you to show or hide one or other of the linked alignment
75       panels.</li>
76     <li>Panel heights are adjusted dragging the divider between
77       them using the mouse</li>
78     <li><a href="../menus/alwview.html"><strong>"View&#8594;New
79           View / Expand Views / Gather Views"</strong></a> behave as for a normal
80       alignment window, but always create new views as Split Frames</li>
81   </ul>
82   <p>
83     An alignment annotation row on the protein alignment shows the <strong><a
84       href="../calculations/consensus.html">cDNA consensus</a></strong> for
85     each peptide column.<br /> This consensus may reveal variation in
86     nucleotides coding for conserved protein residues.
87   </p>
88
89   <a name="opensplit" />
90   <p>
91     <strong>Opening a Split Frame View</strong>
92   </p>
93   <p>A Split Frame View can be opened in one of the following ways:</p>
94   <p>
95     <strong><em>Add Sequences</em></strong>
96   </p>
97   <p>
98     If you add (coding) DNA sequences to an open peptide alignment, or
99     vice versa, <em>and</em> at least one DNA sequence translates to one
100     of the peptide sequences, then the option to open in a split window
101     is offered. The DNA may include start and/or stop codons, but no
102     non-coding (intron) sequence.<br> If more than one cDNA variant
103     is present in the alignment, Jalview will first try to match these
104     to protein sequences based on any retrieved cross-references, and
105     failing that, pairwise as they are ordered in the alignments.
106   <p>This option is available in Jalview Desktop (when adding
107     sequences by any supported method), and Jalview applet (adding from
108     textbox). The additional options below apply to Jalview Desktop
109     only.</p>
110
111   <p>
112     <strong><em>Translate as cDNA</em></strong>
113   </p>
114   <p>
115     Menu option <strong><a href="../menus/alwcalculate.html">"Calculate&#8594;Translate
116         as cDNA"</a></strong> is available for a nucleotide alignment. Selecting this
117     option shows the DNA and its calculated protein product in a Split
118     Frame view.
119   </p>
120
121   <p>
122     <strong><em>Get Cross-References</em></strong>
123   </p>
124   <p>
125     Menu option <strong><a href="../menus/alwcalculate.html">"Calculate&#8594;Get
126         Cross-References"</a></strong> is available for fetched sequences which have
127     cross-references to other databases. On selecting protein
128     cross-references (for a cDNA alignment), or DNA xrefs (for peptide),
129     a Split Frame view is opened showing cDNA and peptide.
130   </p>
131
132   <p>
133     <strong><em>Realign a Split View</em></strong>
134   </p>
135   <p>If you invoke a web service to realign either half of a Split
136     Frame, then the resulting realignment is displayed in a new Split
137     Frame.</p>
138   <ul>
139     <li>the alignment you chose to realign (for example, peptide)
140       is displayed as aligned by the external web service</li>
141     <li>Jalview reconstructs the alignment of its complement (in
142       this case, cDNA) by inserting gaps in the corresponding positions</li>
143   </ul>
144   <p>
145     <a name="reconalignment" /><strong>Reconstructed
146       Alignments</strong>
147   </p>
148   <p>
149     Reconstructed alignments are typically <em>not</em> the same as the
150     alignment produced by aligning the complement sequence set directly
151     with the external service. However, in the case of protein
152     alignments, a reconstructed cDNA alignment is often more reliable
153     than one calculated without coding information. Reconstructed cDNA
154     alignments are also more informative than the original protein
155     alignment when calculating phylogenetic trees or performing other
156     kinds of molecular evolution analysis.
157   </p>
158   <p>
159     <em>Split Frame Views were introduced in Jalview 2.9</em>
160   </p>
161 </body>
162 </html>