help/html/features/splitView.html

   1 <html>
   2 <!--
   3  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9)
   4  * Copyright (C) 2015 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"
  51       >"View&#8594;Automatic 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="../calculate/sorting.html"
  57       >"Calculate&#8594;Sort")</a></strong> 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"
  63       >"Calculate Tree"</a></strong> on one of the views allow both cDNA and
  64       Protein views to be grouped, 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"
  85     >cDNA consensus</a></strong> for each peptide column.<br /> This consensus may
  86     reveal variation in nucleotides coding for conserved protein
  87     residues.
  88   </p>
  89
  90   <a name="opensplit" />
  91   <p>
  92     <strong>Opening a Split Frame View</strong>
  93   </p>
  94   <p>A Split Frame View can be opened in one of the following ways:</p>
  95   <p>
  96     <strong><em>Add Sequences</em></strong>
  97   </p>
  98   <p>
  99     If you add (coding) DNA sequences to an open peptide alignment, or
 100     vice versa, <em>and</em> at least one DNA sequence translates to one
 101     of the peptide sequences, then the option to open in a split window
 102     is offered. The DNA may include start and/or stop codons, but no
 103     non-coding (intron) sequence.<br> If more than one cDNA variant
 104     is present in the alignment, Jalview will first try to match these
 105     to protein sequences based on any retrieved cross-references, and
 106     failing that, pairwise as they are ordered in the alignments.
 107   <p>This option is available in Jalview Desktop (when adding
 108     sequences by any supported method), and Jalview applet (adding from
 109     textbox). The additional options below apply to Jalview Desktop
 110     only.</p>
 111
 112   <p>
 113     <strong><em>Translate as cDNA</em></strong>
 114   </p>
 115   <p>
 116     Menu option <strong><a href="../menus/alwcalculate.html">"Calculate&#8594;Translate
 117         as cDNA"</a></strong> is available for a nucleotide alignment. Selecting this
 118     option shows the DNA and its calculated protein product in a Split
 119     Frame view.
 120   </p>
 121
 122   <p>
 123     <strong><em>Get Cross-References</em></strong>
 124   </p>
 125   <p>
 126     Menu option <strong><a href="../menus/alwcalculate.html">"Calculate&#8594;Get
 127         Cross-References"</a></strong> is available for fetched sequences which have
 128     cross-references to other databases. On selecting protein
 129     cross-references (for a cDNA alignment), or DNA xrefs (for peptide),
 130     a Split Frame view is opened showing cDNA and peptide.
 131   </p>
 132
 133   <p>
 134     <strong><em>Realign a Split View</em></strong>
 135   </p>
 136   <p>If you invoke a web service to realign either half of a Split
 137     Frame, then the resulting realignment is displayed in a new Split
 138     Frame.</p>
 139   <ul>
 140     <li>the alignment you chose to realign (for example, peptide)
 141       is displayed as aligned by the external web service</li>
 142     <li>Jalview reconstructs the alignment of its complement (in
 143       this case, cDNA) by inserting gaps in the corresponding positions</li>
 144   </ul>
 145   <p>
 146     <a name="reconalignment" /><strong>Reconstructed
 147       Alignments</strong>
 148   </p>
 149   <p>
 150     Reconstructed alignments are typically <em>not</em> the same as the
 151     alignment produced by aligning the complement sequence set directly
 152     with the external service. However, in the case of protein
 153     alignments, a reconstructed cDNA alignment is often more reliable
 154     than one calculated without coding information. Reconstructed cDNA
 155     alignments are also more informative than the original protein
 156     alignment when calculating phylogenetic trees or performing other
 157     kinds of molecular evolution analysis.
 158   </p>
 159   <p>
 160     <em>Split Frame Views were introduced in Jalview 2.9</em>
 161   </p>
 162 </body>
 163 </html>