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