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