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