annotate readme.rst @ 2:52f20362d488 draft

Again help updates.
author bgruening
date Wed, 10 Jul 2013 14:53:51 -0400
parents c10e37cca7e3
children 8ee90fc5fe11
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
1 ================================================
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
2 Galaxy wrapper for InterProScan prediction tools
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
3 ================================================
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
4
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
5 InterProScan is a tool that combines different protein signature recognition methods native to the InterPro
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
6 member databases into one resource with look up of corresponding InterPro and GO annotation.
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
7
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
8 This wrapper is copyright 2012-2013 by
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
9 * Bjoern Gruening, Pharmaceutical Bioinformatics, University of Freiburg
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
10 * Konrad Paszkiewicz, Exeter Sequencing Service, University of Exeter
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
11
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
12
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
13 This prepository contains wrapper for the InterProScan command line tool.
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
14 http://www.ebi.ac.uk/interpro/
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
15
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
16
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
17 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
18
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
19
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
20 ============
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
21 Installation
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
22 ============
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
23
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
24 Please download install InterProScan according to:
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
25
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
26 ftp://ftp.ebi.ac.uk/pub/software/unix/iprscan/Installing_InterProScan.txt
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
27
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
28 Please see also:
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
29 ftp://ftp.ebi.ac.uk/pub/software/unix/iprscan/index.html
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
30
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
31 And rebuild the indizes if necessary:
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
32
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
33 index_data.pl -f interpro.xml -inx -v -bin -bforce
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
34 index_data.pl -f match_complete.xml -inx -v -bin -bforce
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
35 index_data.pl -f Pfam-A.seed -inx -v -bin -bforce
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
36 index_data.pl -f Pfam-C -inx -v -bin -bforce
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
37 index_data.pl -f prints.pval -inx -v -bin -bforce
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
38 index_data.pl -f sf.seq -inx -v -bin -bforce
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
39 index_data.pl -f sf_hmm -inx -v -bin -bforce
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
40 index_data.pl -f smart.HMMs -inx -v -bin -bforce
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
41 index_data.pl -f superfamily.hmm -inx -v -bin -bforce
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
42 index_data.pl -f TIGRFAMs_HMM.LIB -inx -v -bin -bforce
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
43
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
44
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
45 Add the tool definition to your tool_conf.xml file under Galaxy root.
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
46 <tool file="iprscan/interproscan.xml" />
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
47
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
48 =============
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
49 Input formats
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
50 =============
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
51
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
52 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
53 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
54 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
55 positional information.
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
56
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
57
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
58 =======
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
59 History
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
60 =======
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
61
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
62 interproscan:
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
63 - v1.1: Initial public release
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
64 - v1.2: Merge with Konrad Paszkiewicz repository
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
65
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
66
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
67 ===============================
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
68 Wrapper Licence (MIT/BSD style)
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
69 ===============================
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
70
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
71 Permission to use, copy, modify, and distribute this software and its
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
72 documentation with or without modifications and for any purpose and
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
73 without fee is hereby granted, provided that any copyright notices
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
74 appear in all copies and that both those copyright notices and this
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
75 permission notice appear in supporting documentation, and that the
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
76 names of the contributors or copyright holders not be used in
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
77 advertising or publicity pertaining to distribution of the software
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
78 without specific prior permission.
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
79
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
80 THE CONTRIBUTORS AND COPYRIGHT HOLDERS OF THIS SOFTWARE DISCLAIM ALL
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
81 WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
82 WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
83 CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
84 OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
85 OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
86 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
87 OR PERFORMANCE OF THIS SOFTWARE.
c10e37cca7e3 Uploaded
bgruening
parents:
diff changeset
88