help/html/features/annotation.html

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