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>,<em>Tooltip text</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>,<em>Tooltip text</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.</p>
  48 <p>Color strings can be embedded in a value field by enclosing an RGB triplet in square brackets to colour that position in an annotation row.
  49 </p>
  50 <p>You can associate an annotation with a sequence by preceding its
  51 definition with the line:
  52 <pre>SEQUENCE_REF&#9;<em>seq_name</em>&#9;<em>[startIndex]</em></pre>
  53 All Annotations defined after a SEQUENCE_REF command will then be
  54 associated with that sequence, and the first field in the Value field
  55 list will (optionally) be placed at the <em>startIndex</em>'th column.</p>
  56 <ul><em>New in Jalview 2.4</em>: the tooltip displayed when the mouse is moved over the row
  57 label for sequence associated annotation  gives the associated
  58 sequence's name followed by the annotation row's description.<br/>
  59 <em>New in Jalview 2.5</em>: Clicking on a sequence or group associated annotation row's label will highlight the sequence or sequence group in the alignment, and double clicking the annotation row label will select the associated sequence or group.</ul>
  60 <p>Sequence associations are turned off for subsequent annotation
  61 definitions by:
  62 <pre>SEQUENCE_REF&#9;ALIGNMENT</pre>
  63 </p>
  64 <p>Since version 2.5, Jalview allows annotation rows to be associated with a group defined on the alignment, by preceding the annotation row with the line:
  65 <pre>GROUP_REF&#9;<em>group_name</em></pre>
  66 Group association is turned off for subsequent annotation rows by
  67 <pre>GROUP_REF&#9;<em>ALIGNMENT</em></pre>
  68 Annotations may be associated with both a sequence and a group, however - group annotations are still experimental and unexpected behaviour may be observed when editing alignments containing both group and sequence associated annotation rows.</p>
  69 <p><em>LINE_GRAPH</em> type annotations can be given a colour
  70 (specified as 24 bit RGB triplet in hexadecimal or comma separated
  71 values), combined onto the same vertical axis, and have ordinate lines
  72 (horizontal lines at a particular vertical axis value) using the
  73 following commands (respectively):
  74 <pre>COLOUR&#9;<em>graph_name</em>&#9;<em>colour</em>
  75 COMBINE&#9;<em>graph_1_name</em>&#9;<em>graph_2_name</em>
  76 GRAPHLINE&#9;<em>graph_name</em>&#9;<em>value</em>&#9;<em>label</em>&#9;<em>colour</em><strong><em>
  77 </em></strong></pre>
  78 <h3><font face="Arial, Helvetica, sans-serif">(Since Jalview 2.5) ROWPROPERTIES</font></h3>
  79 <p>The visual display properties for a set of annotation rows can be modified using the following tab-delimited line:</p>
  80 <pre>ROWPROPERTIES&#9;<em>Row label</em>&#9;<em>centrelabs=true( or false)</em>&#9;<em>showalllabs=true(default is false)</em>&#9;<em>scaletofit=true (default is false)</em></pre>
  81 <p>This sets the visual display properties according to the given values for all the annotation rows with labels matching <em>Row label</em>. The properties mostly affect the display of multi-character column labels, and are as follows:
  82 <ul><li><em>centrelabs</em> Centre each label on its column.</li>
  83 <li><em>showalllabs</em> Show every column label rather than only the first of a run of identical labels (setting this to true can have a drastic effect on secondary structure rows).</li>
  84 <li><em>scaletofit</em> Shrink each label's font size so that the label fits within the column. Useful when annotating an alignment with a specific column numbering system. (<em>Not available in Jalview applet due to AWT 1.1 limitations</em>)</li>
  85 </ul></p>
  86 <h3><font face="Arial, Helvetica, sans-serif">(Since Jalview 2.2.1) SEQUENCE_GROUP</font></h3>
  87 <p>Groups of sequences can be defined using the tab delimited line</p>
  88 <pre>SEQUENCE_GROUP     Group_Name      Group_Start     Group_End       Sequences</pre>
  89 <p>The sequences can be defined by alignment index and a range of sequences can
  90   be defined in a comma delimited field such as</p>
  91 <p>2-5,8-15,20,22</p>
  92 <p>Enter * to select all groups. </p>
  93 <p>If the alignment indices are not known, enter -1 then a tab delimited list
  94   of sequence ids. </p>
  95 <p>If the SEQUENCE_REF has been defined, the group_start and group_end will be
  96   relative to the sequence residue numbering, otherwise the group_start and group_end
  97   will be the alignment column indices. </p>
  98 <p>The group can (optionally) be assigned various visualisation properties via
  99   another tab delimited line thus:</p>
 100 <pre>PROPERTIES Group_name      tab_delimited_key_value_pairs
 101 </pre>
 102 <p>The key_value_pairs allow you to define a description and to colour the group
 103   in various ways. All, none or some of the following values could be used for
 104   a group:</p>
 105 <p>description=Text <br>
 106   colour=Helix Propensity<br>
 107   pidThreshold=0<br>
 108   consThreshold=0<br>
 109   outlineColour=red <br>
 110   displayBoxes=true<br>
 111   displayText=false<br>
 112   colourText=false<br>
 113   textCol1=black<br>
 114   textCol2=black<br>
 115   textColThreshold=0<br>
 116   idColour=ff3322<br>
 117  <!-- Not yet implemented in 2.5 release
 118   hide=false<br>
 119   hidecols=false<br> -->
 120   showunconserved=false</p>
 121 <ul><li><em>New Features in 2.4:</em><br>if the <strong>idColour</strong> property
 122 is given without specifying a colour scheme with the <strong>colour</strong>
 123 property, then the idColour will also be used to colour the sequence.</li>
 124 <li>the <strong>colour</strong> property can take either a colour scheme name,
 125  or a single colour specification (either a colour name like 'red' or an RGB
 126  triplet like 'ff0066'). If a single colour is specified, then the group
 127  will be coloured with that colour.</li>
 128  <!--  <li><em>New Features in 2.5</em></li>
 129  <li>hide and hidecols instruct jalview to hide the sequences or columns covered by the group.</li> -->
 130   <li>Sequence associated Groups<br>If a group is defined after a valid
 131  <em>SEQUENCE_REF</em> sequence reference statement, the sequence representative
 132  for the group will be set to the referenced sequence.<!-- <br><strong>Note:</strong> if the <em>hide</em>
 133  property is set then only the representative sequence for the group will be shown in the alignment.--></li>
 134 </ul>
 135 <p> </p>
 136 <p>An example Annotation file is given below:
 137 <pre>#Comment lines follow the hash symbol
 138 JALVIEW_ANNOTATION
 139 SEQUENCE_REF&#9;FER1_MESCR&#9;5
 140 BAR_GRAPH&#9;Bar Graph 1&#9;||-100,-|-200,-|-300,-|-400,-|200,+|300,+|150,+
 141 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
 142 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
 143 BAR_GRAPH&#9;Bar Graph&#9;2 1,.|2,*|3,:|4,.|5,*|4,:|3,.|2|1|1|2|3|4|5|4
 144 NO_GRAPH&#9;Icons &#9;||||E,Sheet1|E|E||||H,Sheet 2|H|H|H||||||
 145 NO_GRAPH&#9;Purple Letters&#9;m|y|p|r|o|t|e|i|n
 146 COLOUR&#9;Bar Graph 2&#9;blue
 147 COLOUR&#9;Red Values&#9;255,0,0
 148 COLOUR&#9;Green Values&#9;green
 149 COLOUR&#9;Purple Letters&#9;151,52,228
 150 COMBINE&#9;Green Values&#9;Red Values
 151 GRAPHLINE&#9;Red Values&#9;2.6&#9;threshold&#9;black
 152
 153 SEQUENCE_GROUP Group_A 30 50 *
 154 SEQUENCE_GROUP Group_B 1 351 2-5
 155 SEQUENCE_GROUP Group_C 12 14 -1 seq1    seq2    seq3
 156 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
 157 PROPERTIES Group_B outlineColour=red
 158 PROPERTIES Group_C colour=Clustal
 159 </pre>
 160 </p>
 161 </body>
 162 </html>