JAL-3225 save auto formatting settings in org.eclipse.jdt.ui.prefs. Not yet put...
[jalview.git] / help / 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><strong><a name="virtualfeats">Virtual Sequence Features</a></strong>
44   </p>
45   <p>Since Jalview 2.11.1, sequence features displayed in either CDS
46     or Protein can be shown as 'Virtual Features' mapped onto the other
47     view. Features describing non-synonymous genomic sequence variation
48     in coding regions are dynamically translated when shown in the
49     protein view.</p>
50   <p>The display of virtual features and whether they are rendered
51     below or above features local to the aligned sequences is controlled
52     by a check box shown in the view's Sequence Feature Settings dialog
53     box. For convenience, Protein and CDS feature settings for a linked
54     CDS/Protein view are shown as tabs in a single dialog box, allowing
55     easy access to display and filter settings for each view.</p>
56   <p>
57     <img width="631" align="center"
58       alt="Linked CDS and Protein Feature Settings showing Virtual Feature checkbox"
59       src="linkedfeatsettings.png" /> <em>CDS and Protein feature
60       settings tabs and corresponding views showing 'Virtual Features'
61       from each view overlaid on the other (created with Jalview 2.11.1.0).</em>
62   </p>
63   <p>When virtual features are enabled, they are also shown on any
64     linked 3D structure views when 'Colour by Sequence' is enabled, and
65     exported as GFF and Jalview Features files (mapped to their
66     associated virtual coordinates).</p>
67   <p>
68     <strong>Operations supported in Split Frame Mode</strong>
69   </p>
70   <p>Split Frame views allow the following:
71   <ul>
72     <li>Mouseover or scrolling of either alignment is followed by
73       the other (unless you turn off <strong><a
74         href="../menus/alwview.html">"View&#8594;Automatic
75           Scrolling"</a></strong>)
76     </li>
77     <li>On selecting rows, columns or regions in one alignment, the
78       corresponding selection is made in the other</li>
79     <li>Sequence ordering in one alignment (using the cursor, or <strong><a
80         href="../calculations/sorting.html">"Calculate&#8594;Sort")</a></strong>
81       is also applied to the other
82     </li>
83     <li>Editing (gap insertion / deletion) in the protein alignment
84       is reflected in the cDNA (but not vice versa)</li>
85     <li>Any trees imported or created with <strong><a
86         href="../calculations/tree.html">"Calculate Tree"</a></strong> on
87       one of the views allow both cDNA and Protein views to be grouped,
88       coloured or sorted.
89     </li>
90     <li>To allow for the different widths in cDNA and Protein
91       alignments, the <strong><a href="../menus/alwformat.html">"Format&#8594;Font"</a></strong>
92       menu option has an option 'Scale protein residues to codons'. This
93       option will make each protein residue the same width as a DNA
94       codon (so the alignments 'line up' vertically).</li>
95     <li><a name="mirror" />The 'Use same font for cDNA and peptide'
96       checkbox, when enabled, ensures that font or font-size changes in
97       either the cDNA or Protein alignment will also be mirrored. (<em>Added
98         in 2.10.2</em>)</li>
99     <li><strong>"View&#8594;Protein"</strong> (in the cDNA panel)
100       or <strong>"View&#8594;Nucleotide"</strong> (in the protein panel)
101       allows you to show or hide one or other of the linked alignment
102       panels.</li>
103     <li>Panel heights are adjusted by dragging the divider between
104       them using the mouse</li>
105     <li><a href="../menus/alwview.html"><strong>"View&#8594;New
106           View / Expand Views / Gather Views"</strong></a> behave as for a normal
107       alignment window, but always create new views as Split Frames</li>
108   </ul>
109   <p>
110     An alignment annotation row on the protein alignment shows the <strong><a
111       href="../calculations/consensus.html">cDNA consensus</a></strong> for
112     each peptide column.<br /> This consensus may reveal variation in
113     nucleotides coding for conserved protein residues.
114   </p>
115
116   <a name="opensplit" />
117   <p>
118     <strong>Opening a Split Frame View</strong>
119   </p>
120   <p>A Split Frame View can be opened in one of the following ways:</p>
121   <p>
122     <strong><em>Add Sequences</em></strong>
123   </p>
124   <p>
125     If you add (coding) DNA sequences to an open peptide alignment, or
126     vice versa, <em>and</em> at least one DNA sequence translates to one
127     of the peptide sequences, then the option to open in a split window
128     is offered. The DNA may include start and/or stop codons, but no
129     non-coding (intron) sequence.<br> If more than one cDNA variant
130     is present in the alignment, Jalview will first try to match these
131     to protein sequences based on any retrieved cross-references, and
132     failing that, pairwise as they are ordered in the alignments.
133   <p>This option is available in Jalview Desktop (when adding
134     sequences by any supported method), and Jalview applet (adding from
135     textbox). The additional options below apply to Jalview Desktop
136     only.</p>
137
138   <p>
139     <strong><em>Translate as cDNA</em></strong>
140   </p>
141   <p>
142     Menu option <strong><a href="../menus/alwcalculate.html">"Calculate&#8594;Translate
143         as cDNA"</a></strong> is available for a nucleotide alignment. Selecting this
144     option shows the DNA and its calculated protein product in a Split
145     Frame view.
146   </p>
147
148   <p>
149     <strong><em>Get Cross-References</em></strong>
150   </p>
151   <p>
152     Menu option <strong><a href="../menus/alwcalculate.html">"Calculate&#8594;Get
153         Cross-References"</a></strong> is available for fetched sequences which have
154     cross-references to other databases. On selecting protein
155     cross-references (for a cDNA alignment), or DNA xrefs (for peptide),
156     a Split Frame view is opened showing cDNA and peptide.
157   </p>
158
159   <p>
160     <strong><em>Realign a Split View</em></strong>
161   </p>
162   <p>If you invoke a web service to realign either half of a Split
163     Frame, then the resulting realignment is displayed in a new Split
164     Frame.</p>
165   <ul>
166     <li>the alignment you chose to realign (for example, peptide)
167       is displayed as aligned by the external web service</li>
168     <li>Jalview reconstructs the alignment of its complement (in
169       this case, cDNA) by inserting gaps in the corresponding positions</li>
170   </ul>
171   <p>
172     <a name="reconalignment" /><strong>Reconstructed
173       Alignments</strong>
174   </p>
175   <p>
176     Reconstructed alignments are typically <em>not</em> the same as the
177     alignment produced by aligning the complement sequence set directly
178     with the external service. However, in the case of protein
179     alignments, a reconstructed cDNA alignment is often more reliable
180     than one calculated without coding information. Reconstructed cDNA
181     alignments are also more informative than the original protein
182     alignment when calculating phylogenetic trees or performing other
183     kinds of molecular evolution analysis.
184   </p>
185   <p>
186     <em>Split Frame Views were introduced in Jalview 2.9</em>
187   </p>
188 </body>
189 </html>