doco writing.
[jalview.git] / help / html / features / featuresFormat.html
1 <html>\r
2 \r
3 <head><title>Sequence Features File</title></head>\r
4 \r
5 <body>\r
6 <p><strong>Sequence Features File</strong></p>\r
7 <p>The Sequence features file (which used to be known as the &quot;Groups\r
8 file&quot; prior to version 2.08) is a simple way of getting\r
9 your own sequence annotations into Jalview. It was introduced to allow\r
10 sequence features to be rendered in the Jalview applet, and so is\r
11 intentionally lightweight and minimal because the applet is often used\r
12 in situations where data file size must be kept to a minimum, and no\r
13 XML parser is available.</p>\r
14 <p>Features files are imported into Jalview in the following ways:<br>\r
15 <ul>\r
16 <li>from the command line<strong><pre>\r
17  -features &lt;<em>Features filename</em>&gt;</pre></strong></li>\r
18 <li>Dragging a features file onto an alignment window</li>\r
19 <li>Via the &quot;Load Features / Annotations&quot; entry in the\r
20 <strong>File</strong> menu of an alignment window.</li>\r
21 </ul>\r
22 </p>\r
23 <p><strong>Sequence Features File Format</strong></p>\r
24 <p>A features file is a simple ASCII text file, where each line\r
25 contains tab separated text fields. <strong>No comments are\r
26 allowed</strong>.</p>\r
27 <p>The first set of lines contain type definitions:<strong>\r
28 <pre><em>Feature label</em>&#9;<em>Feature Colour</em></pre>\r
29 </strong>A feature type has a text label, and a colour (specified as a\r
30 red,green,blue 24 bit triplet either in hexadecimal (eg. 00ff00) or as comma\r
31 separated numbers (ranging from 0 to 255)).\r
32 <p>The remaining lines in the file are the sequence annotation\r
33 definitions, where the now defined features are attached to regions on\r
34 particular sequences, optionally with some descriptive text (displayed\r
35 in a tooltip when the mouse is near the feature on that sequence). There are two alternate ways of referring to a\r
36 sequence, either by its text ID, or its index in an associated\r
37 alignment.<pre>\r
38 <em>description</em>&#9;<em>sequenceId</em>&#9;<em>sequenceIndex</em>&#9;<em>start</em>&#9;<em>end</em>&#9;<em>featureType</em></pre>Normally,\r
39 sequence features are associated with sequences rather than\r
40 alignments, and the sequenceIndex field is given as &quot;-1&quot;. In\r
41 order to specify a sequence by its index in a particular alignment, the\r
42 sequenceId should be given as &quot;ID_NOT_SPECIFIED&quot;, otherwise the\r
43 sequenceId field will be used in preference to the sequenceIndex field.</p><p>\r
44 Feature annotations can be collected into named groups by prefixing\r
45 definitions with lines of the\r
46 form:<strong><pre>startgroup&#9;groupname</pre></strong>.. and\r
47 subsequently post-fixing the group\r
48 with:<strong><pre>endgroup&#9;groupname</pre></strong>Feature grouping\r
49 was introduced in version 2.08, and used to control whether a set of features\r
50 are either hidden or shown together in the <a href="seqfeatures.html">sequence Feature settings\r
51 dialog box</a>.</p>\r
52 <p>A complete example is shown below :<pre>\r
53 domain&#9;red\r
54 metal ion-binding site&#9;00ff00\r
55 transit peptide&#9;0,105,215\r
56 chain&#9;225,105,0\r
57 modified residue&#9;105,225,35\r
58 signal peptide&#9;0,155,165\r
59 helix&#9;ff0000\r
60 strand&#9;00ff00\r
61 coil&#9;cccccc\r
62 Your Own description here&#9;FER_CAPAA&#9;-1&#9;3&#9;93&#9;domain\r
63 Your Own description here&#9;FER_CAPAN&#9;-1&#9;48&#9;144&#9;chain\r
64 Your Own description here&#9;FER_CAPAN&#9;-1&#9;50&#9;140&#9;domain\r
65 Your Own description here&#9;FER_CAPAN&#9;-1&#9;136&#9;136&#9;modified residue\r
66 Your Own description here&#9;FER1_LYCES&#9;-1&#9;1&#9;47&#9;transit peptide\r
67 Your Own description here&#9;Q93XJ9_SOLTU&#9;-1&#9;1&#9;48&#9;signal peptide\r
68 Your Own description here&#9;Q93XJ9_SOLTU&#9;-1&#9;49&#9;144&#9;chain\r
69 startgroup&#9;secondarystucture\r
70 PDB secondary structure annotation&#9;FER1_SPIOL&#9;-1&#9;52&#9;59&#9;strand\r
71 PDB secondary structure annotation&#9;FER1_SPIOL&#9;-1&#9;74&#9;80&#9;helix\r
72 endgroup&#9;secondarystructure\r
73 </pre>\r
74 </li>\r
75 </p>\r
76 </body>\r
77 </html>\r