annotate readme.rst @ 0:82547f0d3a29 draft

Initial interproscan5 wrapper.
author bgruening
date Tue, 08 Oct 2013 09:18:17 -0400
parents
children e32f2ea6a139
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
1 ================================================
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
2 Galaxy wrapper for InterProScan prediction tools
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
3 ================================================
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
4
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
5 InterProScan is a tool that combines different protein signature recognition methods native to the InterPro
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
6 member databases into one resource with look up of corresponding InterPro and GO annotation.
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
7
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
8 This wrapper is copyright 2013 by:
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
9 * Bjoern Gruening
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
10 * Konrad Paszkiewicz
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
11
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
12
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
13 This prepository contains wrapper for the InterProScan_ command line tool.
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
14
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
15 .. _InterProScan: http://www.ebi.ac.uk/interpro/interproscan.html
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
16
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
17
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
18 Quevillon E., Silventoinen V., Pillai S., Harte N., Mulder N., Apweiler R., Lopez R. (2005). InterProScan: protein domains identifier. Nucleic Acids Res. 33 (Web Server issue): W116-W120
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
19
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
20
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
21 ============
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
22 Installation
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
23 ============
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
24
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
25 Please download install InterProScan according to:
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
26
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
27 https://code.google.com/p/interproscan/wiki/HowToDownload
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
28
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
29
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
30 ========
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
31 Citation
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
32 ========
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
33
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
34 If you use this Galaxy tool in work leading to a scientific
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
35 publication, in addition to citing the invididual underlying tools, please cite:
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
36
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
37 Peter Cock, Bjoern Gruening, Konrad Paszkiewicz and Leighton Pritchard (2013).
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
38 Galaxy tools and workflows for sequence analysis with applications
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
39 in molecular plant pathology. PeerJ 1:e167
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
40 http://dx.doi.org/10.7717/peerj.167
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
41
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
42 Full reference information is included in the help text.
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
43
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
44
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
45 =============
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
46 Input formats
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
47 =============
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
48
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
49 The standard interproscan input is either genomic or protein sequences.
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
50 In the case of genomic sequences Interproscan will run an ORF prediction tool.
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
51
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
52
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
53 =======
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
54 History
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
55 =======
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
56
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
57 interproscan:
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
58
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
59 - v5.0: Initial public release of version 5.0
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
60
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
61
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
62 ===============================
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
63 Wrapper Licence (MIT/BSD style)
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
64 ===============================
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
65
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
66 Permission to use, copy, modify, and distribute this software and its
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
67 documentation with or without modifications and for any purpose and
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
68 without fee is hereby granted, provided that any copyright notices
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
69 appear in all copies and that both those copyright notices and this
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
70 permission notice appear in supporting documentation, and that the
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
71 names of the contributors or copyright holders not be used in
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
72 advertising or publicity pertaining to distribution of the software
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
73 without specific prior permission.
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
74
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
75 THE CONTRIBUTORS AND COPYRIGHT HOLDERS OF THIS SOFTWARE DISCLAIM ALL
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
76 WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
77 WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
78 CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
79 OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
80 OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
81 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
82 OR PERFORMANCE OF THIS SOFTWARE.
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
83