help/html/features/annotation.html

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