2.08 update
[jalview.git] / help / html / features / annotationsFormat.html
1 <html>\r
2 \r
3 <head><title>Annotations File Format</title></head>\r
4 \r
5 <body>\r
6 <p><strong>Alignment Annotations File Format</strong><strong><br>\r
7   </strong><br>\r
8   Note: This format is primarily intended to be used for the applet, which does \r
9   not have an XML parser and where file size must be kept to a minimum to reduce \r
10   download time.</p>\r
11 <p>A precalculated annotations fiile can read onto an alignment from the command \r
12   line (&quot;-annotations&quot;), by drag and dropping the the annotations file \r
13   onto an alignment or by selecting from the File menu &quot;Load Features / Annotations&quot;.</p>\r
14 <p>The File is in tab delimited format. The file must have the line JALVIEW_ANNOTATION \r
15   as an identifier. Then a block of annotations are added in the form GRAPH_TYPE \r
16   Label Values</p>\r
17 <p>GRAPH_TYPE can be either BAR_GRAPH, LINE_GRAPH or NO_GRAPH. The values are \r
18   per alignment column, separated by &quot;|&quot;. Multiple content per column \r
19   can be separated with commas, Jalview will display the content if it interprates \r
20   the content as a text label, or secondary structure character (H or E)</p>\r
21 <p>You can optionally associate an annotation with a sequence by adding a line \r
22   SEQUENCE_REFseq_namestartIndex All Annotations after a SEQUENCE_REF will be \r
23   associated with that sequence. Use SEQUENCE_REF ALIGNMENT to cancel the associtations.</p>\r
24 <p>The visual graphs can be coloured or combined with other graphs, or have an \r
25   arbitrary line drawn at a certain value using the following lines.</p>\r
26 <p><font size="3" face="Courier New, Courier, mono">COLOUR&lt;tab&gt;graph name&lt;tab&gt;colour<br>\r
27   COMBINE&lt;tab&gt;graph 1 name&lt;tab&gt;graph 2 name<br>\r
28   GRAPHLINE&lt;tab&gt;graph name&lt;tab&gt;value&lt;tab&gt;label&lt;tab&gt;colour</font></p>\r
29 <p>An example Annotation file may look like this:</p>\r
30 <p><font size="3" face="Courier New, Courier, mono">#Comment lines follow the hash symbol<br>\r
31   JALVIEW_ANNOTATION<br>\r
32   SEQUENCE_REF FER1_MESCR 5<br>\r
33   BAR_GRAPH&lt;tab&gt;Bar Graph 1&lt;tab&gt;||-100,-|-200,-|-300,-|-400,-|200,+|300,+|150,+<br>\r
34   LINE_GRAPH&lt;tab&gt;Green Values&lt;tab&gt;1.1|2.2|1.3|3.4|0.7|1.4|3.3|2.2|2.1|-1.1|3.2<br>\r
35   LINE_GRAPH&lt;tab&gt;Red Values&lt;tab&gt;2.1|3.2|1.3|-1.4|5.5|1.4|1.3|4.2|-1.1|1.1|3.2<br>\r
36   BAR_GRAPH&lt;tab&gt;Bar Graph&lt;tab&gt;2 1,.|2,*|3,:|4,.|5,*|4,:|3,.|2|1|1|2|3|4|5|4<br>\r
37   NO_GRAPH&lt;tab&gt;Icons &lt;tab&gt;||||E,Sheet1|E|E||||H,Sheet 2|H|H|H||||||<br>\r
38   NO_GRAPH&lt;tab&gt;Purple Letters&lt;tab&gt;m|y|p|r|o|t|e|i|n</font></p>\r
39 <p><font size="3" face="Courier New, Courier, mono">COLOUR&lt;tab&gt;Bar Graph 2&lt;tab&gt;blue<br>\r
40   COLOUR&lt;tab&gt;Red Values&lt;tab&gt;255,0,0<br>\r
41   COLOUR&lt;tab&gt;Green Values&lt;tab&gt;green<br>\r
42   COLOUR&lt;tab&gt;Purple Letters&lt;tab&gt;151,52,228<br>\r
43   COMBINE&lt;tab&gt;Green Values&lt;tab&gt;Red Values</font></p>\r
44 <p><font size="3" face="Courier New, Courier, mono">GRAPHLINE&lt;tab&gt;Red Values&lt;tab&gt;2.6&lt;tab&gt;threshold&lt;tab&gt;black \r
45   </font><br>\r
46 </p>\r
47 <p><br>\r
48 </p>\r
49 </body>\r
50 </html>\r