help/html/features/annotationsFormat.html

   1 <html>
   2
   3 <head>
   4 <title>The Alignment Annotations File</title>
   5 </head>
   6
   7 <body>
   8 <p><strong>The Alignment Annotations File</strong></p>
   9 <p>Alignment annotations can be imported onto an alignment since
  10 version 2.08 of Jalview, via an annotations file. It is a simple ASCII
  11 text file consisting of tab delimited records similar to the <a
  12         href="featuresFormat.html">Sequence Features File</a>, and introduced
  13 primarily for use with the Jalview applet.</p>
  14 <p>Alignment annotations files are imported into Jalview in the
  15 following ways:<br>
  16 <ul>
  17         <li>from the command line<strong><pre>
  18  -annotations &lt;<em>Annotations filename</em>&gt;</pre></strong></li>
  19         <li>Dragging an annotations file onto an alignment window</li>
  20         <li>Via the &quot;Load Features / Annotations&quot; entry in the <strong>File</strong>
  21         menu of an alignment window.</li>
  22 </ul>
  23 </p>
  24 <p><strong>Annotations File Format</strong></p>
  25 <p>The File consists of lines containing an instruction followed by
  26 tab delimited fields, and any lines starting with &quot;#&quot; are
  27 ignored. The first non-commented out line of a valid Annotations file
  28 must begin with :<strong><pre>JALVIEW_ANNOTATION</pre></strong></p>
  29 <p>A row of annotation is added with a line like <strong><pre><em>GRAPH_TYPE</em>&#9;<em>Label</em>&#9;<em>Values</em></pre></strong></p>
  30 <p>The <em>GRAPH_TYPE</em> field, which appears first, defines the
  31 appearance of the annotation row when rendered by Jalview. The next field is the row label for the annotation. The final <em>Values</em> field contains a series of &quot;|&quot;
  32 separated value fields. Each value field is itself a comma separated list of fields of a particular type defined by the annotation row's
  33 GRAPH_TYPE. The allowed values of GRAPH_TYPE and the format of their respective value fields (with the trailing &quot;<strong>|</strong>&quot; symbol) are shown below:<ul>
  34         <li>BAR_GRAPH<br>
  35         Plots a histogram with labels below each bar.<br>
  36         <em>number</em>,<em>text character</em></li>
  37         <li>LINE_GRAPH<br>
  38         Draws a line between values on the annotation row.<br>
  39         <em>number</em></li>
  40         <li>NO_GRAPH<br>
  41         For a row consisting of text labels and/or secondary structure symbols.<br>
  42         <em>{Secondary Structure Symbol}</em>,<em>text label</em><br>
  43         Currently supported secondary structure structure symbols are <em>H</em> (for   helix) and <em>E</em> (for strand)</li>
  44 </ul>
  45 Any or all value fields may be left empty, as well as the BAR_GRAPH's
  46 text character field, and either or both of the text-label and secondary
  47 structure symbol fields of the NO_GRAPH type annotation rows.
  48 </p>
  49 <p>You can associate an annotation with a sequence by preceding its
  50 definition with the line: <strong><pre>SEQUENCE_REF&#9;<em>seq_name</em>&#9;<em>[startIndex]</em></pre></strong>
  51 All Annotations defined after a SEQUENCE_REF command will then be
  52 associated with that sequence, and the first field in the Value field
  53 list will (optionally) be placed at the <em>startIndex</em>'th column.</p>
  54 <p>Sequence associations are turned off for subsequent annotation
  55 definitions by: <strong><pre>SEQUENCE_REF&#9;ALIGNMENT</pre></strong></p>
  56 <p><em>LINE_GRAPH</em> type annotations can be given a colour
  57 (specified as 24 bit RGB triplet in hexadecimal or comma separated
  58 values), combined onto the same vertical axis, and have ordinate lines
  59 (horizontal lines at a particular vertical axis value) using the
  60 following commands (respectively): <strong><pre>COLOUR&#9;<em>graph_name</em>&#9;<em>colour</em>
  61 COMBINE&#9;<em>graph_1_name</em>&#9;<em>graph_2_name</em>
  62 GRAPHLINE&#9;<em>graph_name</em>&#9;<em>value</em>&#9;<em>label</em>&#9;<em>colour</em></pre></strong>
  63 <p>An example Annotation file is given below:
  64 <pre>#Comment lines follow the hash symbol
  65 JALVIEW_ANNOTATION
  66 SEQUENCE_REF&#9;FER1_MESCR&#9;5
  67 BAR_GRAPH&#9;Bar Graph 1&#9;||-100,-|-200,-|-300,-|-400,-|200,+|300,+|150,+
  68 LINE_GRAPH&#9;Green Values&#9;1.1|2.2|1.3|3.4|0.7|1.4|3.3|2.2|2.1|-1.1|3.2
  69 LINE_GRAPH&#9;Red Values&#9;2.1|3.2|1.3|-1.4|5.5|1.4|1.3|4.2|-1.1|1.1|3.2
  70 BAR_GRAPH&#9;Bar Graph&#9;2 1,.|2,*|3,:|4,.|5,*|4,:|3,.|2|1|1|2|3|4|5|4
  71 NO_GRAPH&#9;Icons &#9;||||E,Sheet1|E|E||||H,Sheet 2|H|H|H||||||
  72 NO_GRAPH&#9;Purple Letters&#9;m|y|p|r|o|t|e|i|n
  73 COLOUR&#9;Bar Graph 2&#9;blue
  74 COLOUR&#9;Red Values&#9;255,0,0
  75 COLOUR&#9;Green Values&#9;green
  76 COLOUR&#9;Purple Letters&#9;151,52,228
  77 COMBINE&#9;Green Values&#9;Red Values
  78 GRAPHLINE&#9;Red Values&#9;2.6&#9;threshold&#9;black
  79 </pre>
  80 </p>
  81 </body>
  82 </html>