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:
  51 <pre>SEQUENCE_REF&#9;<em>seq_name</em>&#9;<em>[startIndex]</em></pre>
  52 All Annotations defined after a SEQUENCE_REF command will then be
  53 associated with that sequence, and the first field in the Value field
  54 list will (optionally) be placed at the <em>startIndex</em>'th column.</p>
  55 <p>Sequence associations are turned off for subsequent annotation
  56 definitions by:
  57 <pre>SEQUENCE_REF&#9;ALIGNMENT</pre>
  58 </p>
  59 <p><em>LINE_GRAPH</em> type annotations can be given a colour
  60 (specified as 24 bit RGB triplet in hexadecimal or comma separated
  61 values), combined onto the same vertical axis, and have ordinate lines
  62 (horizontal lines at a particular vertical axis value) using the
  63 following commands (respectively):
  64 <pre>COLOUR&#9;<em>graph_name</em>&#9;<em>colour</em>
  65 COMBINE&#9;<em>graph_1_name</em>&#9;<em>graph_2_name</em>
  66 GRAPHLINE&#9;<em>graph_name</em>&#9;<em>value</em>&#9;<em>label</em>&#9;<em>colour</em><strong><em>
  67 </em></strong></pre>
  68 <h3><font face="Arial, Helvetica, sans-serif">(Since Jalview 2.2.1) SEQUENCE_GROUP</font></h3>
  69 <p>Groups of sequences can be defined using the tab delimited line</p>
  70 <pre>SEQUENCE_GROUP     Group_Name      Group_Start     Group_End       Sequences</pre>
  71 <p>The sequences can be defined by alignment index and a range of sequences can
  72   be defined in a comma delimited field such as</p>
  73 <p>2-5,8-15,20,22</p>
  74 <p>Enter * to select all groups. </p>
  75 <p>If the alignment indices are not known, enter -1 then a tab delimited list
  76   of sequence ids. </p>
  77 <p>If the SEQUENCE_REF has been defined, the group_start and group_end will be
  78   relative to the sequence residue numbering, otherwise the group_start and group_end
  79   will be the alignment column indices. </p>
  80 <p>The group can (optionally) be assigned various visualisation properties via
  81   another tab delimited line thus:</p>
  82 <pre>PROPERTIES Group_name      tab_delimited_key_value_pairs
  83 </pre>
  84 <p>The key_value_pairs allow you to define a description and to colour the group
  85   in various ways. All, none or some of the following values could be used for
  86   a group:</p>
  87 <p>description=Text <br>
  88   colour=Helix Propensity<br>
  89   pidThreshold=0<br>
  90   consThreshold=0<br>
  91   outlineColour=red <br>
  92   displayBoxes=true<br>
  93   displayText=false<br>
  94   colourText=false<br>
  95   textCol1=black<br>
  96   textCol2=black<br>
  97   textColThreshold=0<br>
  98   idColour=ff3322</p>
  99 <em>New Features in 2.4:</em><ul><li>if the <strong>idColour</strong> property
 100 is given without specifying a colour scheme with the <strong>colour</strong>
 101 property, then the idColour will also be used to colour the sequence.</li>
 102 <li>the <strong>colour</strong> property can take either a colour scheme name,
 103  or a single colour specification (either a colour name like 'red' or an RGB
 104  triplet like 'ff0066'). If a single colour is specified, then the group
 105  will be coloured with that colour.</li>
 106 </ul>
 107 <p> </p>
 108 <p>An example Annotation file is given below:
 109 <pre>#Comment lines follow the hash symbol
 110 JALVIEW_ANNOTATION
 111 SEQUENCE_REF&#9;FER1_MESCR&#9;5
 112 BAR_GRAPH&#9;Bar Graph 1&#9;||-100,-|-200,-|-300,-|-400,-|200,+|300,+|150,+
 113 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
 114 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
 115 BAR_GRAPH&#9;Bar Graph&#9;2 1,.|2,*|3,:|4,.|5,*|4,:|3,.|2|1|1|2|3|4|5|4
 116 NO_GRAPH&#9;Icons &#9;||||E,Sheet1|E|E||||H,Sheet 2|H|H|H||||||
 117 NO_GRAPH&#9;Purple Letters&#9;m|y|p|r|o|t|e|i|n
 118 COLOUR&#9;Bar Graph 2&#9;blue
 119 COLOUR&#9;Red Values&#9;255,0,0
 120 COLOUR&#9;Green Values&#9;green
 121 COLOUR&#9;Purple Letters&#9;151,52,228
 122 COMBINE&#9;Green Values&#9;Red Values
 123 GRAPHLINE&#9;Red Values&#9;2.6&#9;threshold&#9;black
 124
 125 SEQUENCE_GROUP Group_A 30 50 *
 126 SEQUENCE_GROUP Group_B 1 351 2-5
 127 SEQUENCE_GROUP Group_C 12 14 -1 seq1    seq2    seq3
 128 PROPERTIES Group_A description=This is the description colour=Helix Propensity pidThreshold=0 outlineColour=red displayBoxes=true displayText=false     colourText=false textCol1=black textCol2=black textColThreshold=0
 129 PROPERTIES Group_B outlineColour=red
 130 PROPERTIES Group_C colour=Clustal
 131 </pre>
 132 </p>
 133 </body>
 134 </html>