help/html/features/annotation.html

   1 <html>
   2 <head><title>Alignment Annotation</title></head>
   3 <body>
   4 <p><strong>Alignment Annotation</strong></p>
   5
   6 <p>In addition to the definition of groups and sequence features,
   7   Jalview can display symbols and graphs under the columns of an
   8   alignment, and allow you to mark particular columns of an alignment and add symbols and text
   9   in the annotation area shown below the alignment (which may be hidden if <strong>View&#8594;Show
  10   Annotation</strong> is not ticked). </p>
  11 <p>Web services can also add annotation to an alignment (see the
  12   <a href="../webServices/jnet.html">JNet web service</a>), and as of Jalview 2.08 quantitative and symbolic
  13   annotations can be added to an alignment via an <a href="annotationsFormat.html">Annotations
  14   File</a> dragged into the alignment window or loaded from the
  15   alignment's file menu.</p>
  16 <p><strong>Interactive Alignment Annotation</strong></p>
  17 <p>
  18 Annotation rows are added using the <strong>Annotation Label</strong>
  19 menu, which is obtained by clicking anywhere on the annotation row labels
  20 area (below the sequence ID area).
  21 </p>
  22 <ul>
  23   <li>Add New Row<br>
  24     <em>Adds a new, named annotation row (a dialog box will pop up for you to
  25     enter the label for the new row). </em> </li>
  26   <li>Hide Row<br>
  27     <em>Hides the annotation row whose label was clicked in order to bring up
  28     the menu.</em> </li>
  29   <li>Delete Row<br>
  30     <em>Deletes the annotation row whose label was clicked in order to bring up
  31     the menu.</em> </li>
  32   <li>Show All Hidden Rows<br>
  33     <em>Shows all hidden annotation rows.</em> </li>
  34           <li><strong>Export Annotation</strong> <em>(Application only)</em><br>
  35        <em>Annotations can be saved to file or output to a text window in either the
  36         Jalview annotations format or as a spreadsheet style set of comma separated values (CSV). </em> </li>
  37       <li><strong>Show Values in Text Box</strong> <em>(applet only)</em><br>
  38         <em>Opens a text box with a list of comma-separated values corresponding
  39         to the annotation (numerical or otherwise) at each position in the row.
  40         This is useful to export alignment quality measurements for further analysis.</em>
  41       </li>
  42 </ul>
  43 <p>
  44 <strong>Editing Label and secondary structure Annotation</strong></p>
  45 <p>
  46 Use the <strong>left mouse button</strong> to select a position along the row that are to
  47 be annotated - these regions will be coloured red. <strong>Control</strong> and <strong>shift</strong> in combination
  48 with the left-click will select more than one position, or a range of
  49 positions on the alignment.
  50 </p>
  51 <p>Once the desired position has been selected, use the <strong>right mouse
  52 button</strong> to open the <strong>annotation menu</strong>:</p>
  53 <ul>
  54 <li>Helix<br><em>Mark selected positions with a helix glyph (a red
  55 oval), and optional text label (see below). A
  56 dialog box will open for you to enter the text. Consecutive ovals
  57 will be rendered as an unbroken red line.</em>
  58 </li>
  59 <li>Sheet<br><em>Mark selected positions with a sheet glyph (a green
  60 arrow oriented from left to right), and optional text label (see
  61 below). A dialog box will open for you to enter the text. Consecutive
  62 arrows will be joined together to form a single green arrow.</em>
  63 </li>
  64 <li>Label<br><em>Set the text label at the selected positions. A
  65 dialog box will open for you to enter the text.  If
  66 more that one consecutive position is marked with the same label, only
  67 the first position's label will be rendered.</em>
  68 </li>
  69 <li>Colour<br><em>Changes the colour of the annotation text label.</em>
  70 </li>
  71 <li>Remove Annotation<br><em>Blanks any annotation at the selected positions on
  72 the row. Note: <strong>This cannot be undone</strong></em>
  73 </li>
  74 </ul>
  75 <p>
  76 User defined annotation is stored and retrieved using <a
  77 href="../features/jalarchive.html">Jalview Archives</a>.
  78 </p>
  79 <p><em>Current Limitations</em></p>
  80
  81 <p>In the current version of Jalview, reordering of the annotation
  82 rows is not possible. If you save
  83 your annotation as a Jalview file, however, it will be reloaded with user
  84 annotations at the top (nearest the alignment), above any of the
  85 automatically generated Conservation, Quality or consensus
  86 annotations. Finally, the Jalview GUI will not, as yet, allow you to output
  87 Jalview annotation files for the current alignment, change the line
  88 colour, display style, or create groups of quantitative annotation rows.</p>
  89 </body>
  90 </html>