1dded28b838e6f37686aaa99d467eccdd58489af
[jalview.git] / help / html / io / modellerpir.html
1 #-------------------------------------------------------------------------------
2 # Jalview - A Sequence Alignment Editor and Viewer (Version 2.5.1)
3 # Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
4
5 # This file is part of Jalview.
6
7 # Jalview is free software: you can redistribute it and/or
8 # modify it under the terms of the GNU General Public License 
9 # as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
10
11 # Jalview is distributed in the hope that it will be useful, but 
12 # WITHOUT ANY WARRANTY; without even the implied warranty 
13 # of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
14 # PURPOSE.  See the GNU General Public License for more details.
15
16 # You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
17 #-------------------------------------------------------------------------------
18 <html>
19 <!--
20  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)
21  * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
22  * 
23  * This file is part of Jalview.
24  * 
25  * Jalview is free software: you can redistribute it and/or
26  * modify it under the terms of the GNU General Public License 
27  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
28  * 
29  * Jalview is distributed in the hope that it will be useful, but 
30  * WITHOUT ANY WARRANTY; without even the implied warranty 
31  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
32  * PURPOSE.  See the GNU General Public License for more details.
33  * 
34  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
35 -->
36 <head>
37 <title>Modeller PIR Format IO</title>
38 </head>
39 <body>
40 <p><strong>Modeller PIR Format IO</strong></p>
41 <p>The homology modelling program, <a
42 href="http://salilab.org/modeller/">Modeller</a> uses a special form
43 of the PIR format where information about sequence numbering and chain
44 codes are written into the 'description' line between the PIR protein
45 tag and the protein alignment entry:</p>
46 <pre>&gt;P1;Q93Z60_ARATH
47 sequence:Q93Z60_ARATH:1:.:118:.:.
48 ----MASTALSSAIVSTSFLRRQQTPISLRSLPFANT-QSLFGLKS-STARGGRVTAMATYKVKFITPEGEQ
49 EVECEEDVYVLDAAEEAGLDLPYSCRAGSCSSCAGKVVSGSIDQSD------QSFLD-D-------------
50 ---------------------*
51 &gt;P1;PDB|1FER|_
52 structureX:1FER:1:.:105:.:.
53 ----------------------------------------------------AFVVTDNCIKCKY---TDCV
54 EV-CPVDCFY----EGPNFLVIHPDECIDCALCEPECPAQAIFSEDEVPEDMQEFIQLNAELAEVWPNITEK
55 KDPLPDAEDWDGVKGKLQHLE*
56 </pre>
57 <p>Jalview will attempt to parse any PIR entries conforming to the
58 Modeller/PIR format, in order to extract the sequence start and end
59 numbering and (possibly) a PDB file reference. The description line
60 information is always stored in the sequence description string - so
61 no information is lost if this parsing process fails.</p>
62 <p>The 'Modeller Output' flag in the 'Output' tab of the Jalview <a href="../features/preferences.html">Preferences dialog
63 box</a> controls whether Jalview will also output MODELLER style PIR
64 files. In this case, any existing 'non-modeller PIR' header
65 information in the description string of an alignment is appended to
66 an automatically generated modeller description line for that
67 sequence.</p>
68 <p>The general format used for generating the Modeller/PIR sequence
69 description line is shown below :
70 <pre>&gt;P1;<em>Primary_Sequence_ID</em>
71 <em>sequence or structureX</em>:<em>pdb-reference if
72   available</em>:<em>start residue</em>:<em>start chain code</em>:<em>end
73   residue</em>:<em>end chain code</em>:. <em>description text</em></pre>
74 The first field is either sequence or structureX, depending upon the
75 presence of a PDB database ID for the sequence. If the protein has no
76 PDB reference, then the chain code is not specified, unless one
77 already existed when the sequence was imported into Jalview.
78 </body>
79 </html>