annotate readme.rst @ 3:8ee90fc5fe11 draft

Uploaded
author bgruening
date Tue, 08 Oct 2013 10:22:52 -0400
parents c10e37cca7e3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
1 ==================================================
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
2 Galaxy wrapper for InterProScan 4 prediction tools
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
3 ==================================================
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
4
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
5 **Note**:
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
6
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
7 This wrapper is for InterProScan 4.x if you want to use InterProScan 5 please have a look at:
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
8 http://toolshed.g2.bx.psu.edu/view/bgruening/interproscan5
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
9
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
10 -----
0
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
11
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
12 InterProScan is a tool that combines different protein signature recognition methods native to the InterPro
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
13 member databases into one resource with look up of corresponding InterPro and GO annotation.
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
14
3
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
15 This wrapper is copyright 2012-2013 by:
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
16 * Bjoern Gruening, Pharmaceutical Bioinformatics, University of Freiburg
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
17 * Konrad Paszkiewicz, Exeter Sequencing Service, University of Exeter
0
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
18
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
19
3
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
20 This prepository contains wrapper for the InterProScan_ command line tool.
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
21
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
22 .. _InterProScan: http://www.ebi.ac.uk/interpro/
0
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
23
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
24
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
25 Zdobnov E.M. and Apweiler R. "InterProScan - an integration platform for the signature-recognition methods in InterPro" Bioinformatics, 2001, 17(9): p. 847-8.
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
26
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
27
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
28 ============
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
29 Installation
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
30 ============
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
31
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
32 Please download install InterProScan according to:
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
33
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
34 ftp://ftp.ebi.ac.uk/pub/software/unix/iprscan/Installing_InterProScan.txt
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
35
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
36 Please see also:
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
37 ftp://ftp.ebi.ac.uk/pub/software/unix/iprscan/index.html
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
38
3
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
39 And rebuild the indizes if necessary
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
40
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
41 .. code::
0
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
42
3
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
43 index_data.pl -f interpro.xml -inx -v -bin -bforce
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
44 index_data.pl -f match_complete.xml -inx -v -bin -bforce
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
45 index_data.pl -f Pfam-A.seed -inx -v -bin -bforce
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
46 index_data.pl -f Pfam-C -inx -v -bin -bforce
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
47 index_data.pl -f prints.pval -inx -v -bin -bforce
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
48 index_data.pl -f sf.seq -inx -v -bin -bforce
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
49 index_data.pl -f sf_hmm -inx -v -bin -bforce
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
50 index_data.pl -f smart.HMMs -inx -v -bin -bforce
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
51 index_data.pl -f superfamily.hmm -inx -v -bin -bforce
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
52 index_data.pl -f TIGRFAMs_HMM.LIB -inx -v -bin -bforce
0
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
53
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
54
3
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
55 Add the tool definition to your tool_conf.xml file under Galaxy root:
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
56 .. code::
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
57
0
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
58 <tool file="iprscan/interproscan.xml" />
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
59
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
60 =============
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
61 Input formats
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
62 =============
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
63
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
64 The standard interproscan input is either genomic or protein sequences. In the case of genomic sequences Interproscan will run an ORF
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
65 prediction tool. However this tends to lose the ORF information (e.g. start/end co-ordinates) from the header. As such the requirement here is to input ORF
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
66 sequences (e.g. from EMBOSS getorf) and to then replace any spaces in the FASTA header with underscores. This workaround generally preserves the relevant
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
67 positional information.
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
68
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
69
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
70 =======
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
71 History
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
72 =======
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
73
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
74 interproscan:
3
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
75
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
76 - v1.1: Initial public release
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
77 - v1.2: Merge with Konrad Paszkiewicz repository
0
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
78
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
79
3
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
80 =============
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
81 Licence (MIT)
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
82 =============
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
83
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
84 Permission is hereby granted, free of charge, to any person obtaining a copy
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
85 of this software and associated documentation files (the "Software"), to deal
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
86 in the Software without restriction, including without limitation the rights
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
87 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
88 copies of the Software, and to permit persons to whom the Software is
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
89 furnished to do so, subject to the following conditions:
0
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
90
3
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
91 The above copyright notice and this permission notice shall be included in
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
92 all copies or substantial portions of the Software.
0
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
93
3
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
94 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
95 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
96 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
97 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
98 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
99 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
8ee90fc5fe11 Uploaded
bgruening
parents: 0
diff changeset
100 THE SOFTWARE.
0
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
101