annotate anarci_wrapper.xml @ 3:3d49bef78c3d draft default tip

MAJ way to directory
author p.lucas
date Tue, 30 Mar 2021 14:38:03 +0000
parents 58b36867b577
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
3d49bef78c3d MAJ way to directory
p.lucas
parents: 2
diff changeset
1 <tool id="ANARCI" name="ANARCI" version="3.0">
2
58b36867b577 Fix bug to load env
p.lucas
parents: 1
diff changeset
2 <description>Use ANARCI tools to use HADDOCK-antibody-antigen after.</description>
0
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
3 <command detect_errors="exit_code"><![CDATA[
2
58b36867b577 Fix bug to load env
p.lucas
parents: 1
diff changeset
4 source /home/galaxy/data/_conda/bin/activate Ab-HADDOCK;
3
3d49bef78c3d MAJ way to directory
p.lucas
parents: 2
diff changeset
5 python2.7 /home/galaxy/HADDOCK-antibody-antigen/ImmunoPDB.py -i '${input}' -o '${output}' --scheme ${scheme} --splitscfv
0
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
6 #if $receptor
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
7 --receptor ${receptor}
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
8 #end if;
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
9 #if $fvonly
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
10 --fvonly
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
11 #end if;
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
12 #if $rename
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
13 --rename
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
14 #end if;
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
15 #if $splitscfv
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
16 --splitscfv
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
17 #end if;
2
58b36867b577 Fix bug to load env
p.lucas
parents: 1
diff changeset
18 ;
58b36867b577 Fix bug to load env
p.lucas
parents: 1
diff changeset
19 source /home/galaxy/data/_conda/bin/deactivate
0
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
20 ]]></command>
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
21 <inputs>
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
22 <param format="pdb" name="input" type="data" label="Select your PDB file."/>
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
23 <param name="scheme" type="select" label="Scheme to use - default is 'IMGT'" help="Which numbering scheme should be used.">
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
24 <option value="imgt" selected="true">IMGT</option>
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
25 <option value="kabat">Kabat</option>
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
26 <option value="aho">Aho</option>
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
27 <option value="wolfguy">Wolfguy</option>
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
28 <option value="chothia">Chothia</option>
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
29 <option value="martin">Martin</option>
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
30 <option value="pdb">PDB</option>
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
31 </param>
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
32 <param name="receptor" type="select" optional="true" label="Choose ig or tr domains" help="Choose whether to number Antibody (ig) or TCR (tr) domains. (Optional)">
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
33 <option value="ig" >Antibody domains</option>
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
34 <option value="tr" >TCR domains</option>
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
35 </param>
1
9a66e3a9ff53 Uploaded
p.lucas
parents: 0
diff changeset
36 <param name="fvonly" type="boolean" optional="true" label="Only output Fv regions." help="Only output Fv regions."/>
9a66e3a9ff53 Uploaded
p.lucas
parents: 0
diff changeset
37 <param name="rename" type="boolean" optional="true" label="Rename the receptor chains." help="Rename the receptor chains with H and L (ig) or B and A (tr). Only receptor chains output. First pair identified used."/>
9a66e3a9ff53 Uploaded
p.lucas
parents: 0
diff changeset
38 <param name="splitscfv" type="boolean" optional="true" label="Split chain." help="When they are found split single chain fvs into two seperate chains (fvonly becomes true)."/>
0
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
39 </inputs>
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
40 <outputs>
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
41 <data name="output" format="pdb" />
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
42 </outputs>
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
43 <help>
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
44 usage: ImmunoPDB [-h] [-i INPUTSTRUCTURE] [-o OUTFILE]
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
45 [--scheme {kabat,aho,wolfguy,imgt,a,c,chothia,i,k,m,w,martin,pdb}]
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
46 [--receptor {ig,tr}] [--rename] [--fvonly] [--splitscfv]
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
47 [--warnings]
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
48
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
49 ANARCI - ImmunoPDB \\ //
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
50 Antibody Numbering and Antigen Receptor ClassIfication \\ //
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
51 ||
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
52 (c) Oxford Protein Informatics Group (OPIG). 2015-16 ||
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
53
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
54 Example script to number Antibody and TCR PDB structures.
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
55
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
56 ANARCI must be installed and in the path
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
57 opig.stats.ox.ac.uk/webapps/anarci
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
58
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
59 Requirements: Biopython (version >= 1.66)
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
60 Muscle
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
61
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
62 This script extends the BioPython PDBParser and Structure classes so that a numbering scheme can be applied to the variable domain
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
63 of an antigen receptor chain.
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
64
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
65 o Where available the Seqres record is used as the full sequence. Missing residues are recognised by comparing this to the residues
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
66 with coordinates.
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
67
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
68 o *Only* variable domains are numbered consistently in the chosen scheme.
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
69
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
70 o Residues before the domain are numbered '0' with reverse alphabetical insertions if there are less than 28 (all 0 otherwise - this
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
71 will break some PDB parsers...)
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
72
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
73 o Residues after the variable domain are numbered sequentially from 1001.
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
74
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
75 o By default when more than one variable domain is found on a single chain (e.g. single chain Fv, diabody...) the numbering will be
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
76 with respect to the first domain identified.
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
77
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
78 o CDR recognition is performed and regions are annotated in the xtra dictionary attributes of residue objects.
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
79
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
80 o Pairing is performed using the distance between the interface cysteine positions (imgt 104).
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
81
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
82 Basic useage
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
83
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
84 Renumber antibody chains with imgt numbering scheme
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
85 python ImmunoPDB.py -i infile.pdb -o outfile.pdb -s imgt
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
86
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
87 Renumber tcr chains with imgt numbering scheme
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
88 python ImmunoPDB.py -i infile.pdb -o outfile.pdb -s imgt --receptor tr
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
89
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
90 optional arguments:
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
91 -h, --help show this help message and exit
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
92 -i INPUTSTRUCTURE A structure to be numbered
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
93 -o OUTFILE The output file to use. Default is stdout
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
94 --scheme {kabat,aho,wolfguy,imgt,a,c,chothia,i,k,m,w,martin,pdb}, -s {kabat,aho,wolfguy,imgt,a,c,chothia,i,k,m,w,martin,pdb}
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
95 Which numbering scheme should be used. i, k, c, m, w
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
96 and a are shorthand for IMGT, Kabat, Chothia, Martin
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
97 (Extended Chothia), Wolfguy and Aho respectively.
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
98 Default IMGT. Use pdb to retain the numbering but get
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
99 the annotations as remarks
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
100 --receptor {ig,tr}, -r {ig,tr}
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
101 Choose whether to number Antibody (ig) or TCR (tr)
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
102 domains.
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
103 --rename Rename the receptor chains with H and L (ig) or B and
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
104 A (tr). Only receptor chains output. First pair
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
105 identified used.
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
106 --fvonly Only output Fv regions.
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
107 --splitscfv When they are found split single chain fvs into two
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
108 seperate chains (fvonly becomes true)
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
109 --warnings Report warnings about missing residues
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
110
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
111 Author: James Dunbar (dunbar@stats.ox.ac.uk)
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
112 Charlotte Deane (deane@stats.ox.ac.uk)
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
113
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
114 Copyright (C) 2016 Oxford Protein Informatics Group (OPIG)
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
115 Freely distributed under the GNU General Public License (GPLv3).
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
116 </help>
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
117 </tool>
ef67bbb84e6b Uploaded
p.lucas
parents:
diff changeset
118