help/html/features/annotation.html

   1 <html>
   2 <!--
   3  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.1)
   4  * Copyright (C) 2014 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 of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  18  * The Jalview Authors are detailed in the 'AUTHORS' file.
  19 -->
  20 <head><title>Alignment Annotation</title></head>
  21 <body>
  22 <p><strong>Alignment Annotation</strong></p>
  23
  24 <p>In addition to the definition of groups and sequence features,
  25   Jalview can display symbols and graphs under the columns of an
  26   alignment, and allow you to mark particular columns of an alignment and add symbols and text
  27   in the annotation area shown below the alignment (which may be hidden if <strong>View&#8594;Show
  28   Annotation</strong> is not ticked). Any displayed annotation row can be hidden (using the pop-up
  29   menu obtained by right-clicking the label), or re-ordered by dragging the label to a new
  30   position with the left mouse button.</p>
  31 <p>
  32 Web services can also add annotation to an alignment (see the <a
  33 href="../webServices/jnet.html">JNet</a> and <a
  34 href="../webServices/proteinDisorder.html">Disorder</a> protein
  35 structure prediction services), and as of Jalview 2.08 quantitative
  36 and symbolic annotations can be added to an alignment via an <a
  37 href="annotationsFormat.html">Annotations File</a> dragged into the
  38 alignment window or loaded from the alignment's file menu.
  39 </p>
  40 <p><strong>Interactive Alignment Annotation</strong></p>
  41 <p>
  42 Annotation rows are added using the <strong>Annotation Label</strong>
  43 menu, which is obtained by clicking anywhere on the annotation row labels
  44 area (below the sequence ID area).
  45 </p>
  46 <ul>
  47   <li>Add New Row<br>
  48     <em>Adds a new, named annotation row (a dialog box will pop up for you to
  49     enter the label for the new row). </em> </li>
  50   <li>Hide Row<br>
  51     <em>Hides the annotation row whose label was clicked in order to bring up
  52     the menu.</em> </li>
  53   <li>Delete Row<br>
  54     <em>Deletes the annotation row whose label was clicked in order to bring up
  55     the menu.</em> </li>
  56   <li>Show All Hidden Rows<br>
  57     <em>Shows all hidden annotation rows.</em> </li>
  58           <li><strong>Export Annotation</strong> <em>(Application only)</em><br>
  59        <em>Annotations can be saved to file or output to a text window in either the
  60         Jalview annotations format or as a spreadsheet style set of comma separated values (CSV). </em> </li>
  61       <li><strong>Show Values in Text Box</strong> <em>(applet only)</em><br>
  62         <em>Opens a text box with a list of comma-separated values corresponding
  63         to the annotation (numerical or otherwise) at each position in the row.
  64         This is useful to export alignment quality measurements for further analysis.</em>
  65       </li>
  66       <li><strong>Scale Label To Column</strong><em>(introduced in 2.5)</em><br>
  67       <em>Selecting this toggles whether column labels will be shrunk to fit within each column, or displayed using the view's standard font size.</em></li>
  68 </ul>
  69 <p>
  70 <strong>Editing Label and secondary structure Annotation</strong></p>
  71 <p>
  72 Use the <strong>left mouse button</strong> to select a position along the row that are to
  73 be annotated - these regions will be coloured red. <strong>Control</strong> and <strong>shift</strong> in combination
  74 with the left-click will select more than one position, or a range of
  75 positions on the alignment.
  76 </p>
  77 <p>Once the desired position has been selected, use the <strong>right mouse
  78 button</strong> to open the <strong>annotation menu</strong>:</p>
  79 <ul>
  80 <li>Helix<br><em>Mark selected positions with a helix glyph (a red
  81 oval), and optional text label (see below). A
  82 dialog box will open for you to enter the text. Consecutive ovals
  83 will be rendered as an unbroken red line.</em>
  84 </li>
  85 <li>Sheet<br><em>Mark selected positions with a sheet glyph (a green
  86 arrow oriented from left to right), and optional text label (see
  87 below). A dialog box will open for you to enter the text. Consecutive
  88 arrows will be joined together to form a single green arrow.</em>
  89 </li>
  90 <li><a name="rna">RNA Helix</a> (only shown when working with nucleotide sequences)<br>
  91 <em>Mark selected positions as participating in a base pair
  92 either upstream or downstream. When the dialog box opens, enter a
  93 '(' to indicate these bases pair with columns upstream (to right),
  94 and ')' to indicate this region pairs with bases to the left of the
  95 highlighted columns.<br />If any brackets do not match up, then an
  96 orange square will highlight the first position where a bracket was
  97 found not to match.
  98 </em>
  99 </li>
 100 <li>Label<br><em>Set the text label at the selected positions. A
 101 dialog box will open for you to enter the text.  If
 102 more that one consecutive position is marked with the same label, only
 103 the first position's label will be rendered.</em>
 104 </li>
 105 <li>Colour<br><em>Changes the colour of the annotation text label.</em>
 106 </li>
 107 <li>Remove Annotation<br><em>Blanks any annotation at the selected positions on
 108 the row. Note: <strong>This cannot be undone</strong></em>
 109 </li>
 110 </ul>
 111 <p>
 112 User defined annotation is stored and retrieved using <a
 113 href="../features/jalarchive.html">Jalview Archives</a>.
 114 </p>
 115 <p><em>Current Limitations</em></p>
 116 <p>As of version 2.5, the Jalview user interface does not support the
 117 creation and editing quantitative annotation (histograms and line graphs), or
 118 to create annotation associated with a specific sequence. It is also incapable of
 119 annotation grouping or changing the style of existing annotation (to change between line or bar charts, or to make multiple line graphs). These annotation capabilities are only possible by the import of an
 120 <a href="annotationsFormat.html">Annotation file</a>.<br>
 121 </p>
 122 </body>
 123 </html>