annotate readme.rst @ 1:e32f2ea6a139 draft default tip

Uploaded
author bgruening
date Tue, 08 Oct 2013 10:23:22 -0400
parents 82547f0d3a29
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
e32f2ea6a139 Uploaded
bgruening
parents: 0
diff changeset
1 ==================================================
e32f2ea6a139 Uploaded
bgruening
parents: 0
diff changeset
2 Galaxy wrapper for InterProScan 5 prediction tools
e32f2ea6a139 Uploaded
bgruening
parents: 0
diff changeset
3 ==================================================
0
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
1
e32f2ea6a139 Uploaded
bgruening
parents: 0
diff changeset
13 This prepository contains a wrapper for the InterProScan_ command line tool.
0
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
1
e32f2ea6a139 Uploaded
bgruening
parents: 0
diff changeset
62 =============
e32f2ea6a139 Uploaded
bgruening
parents: 0
diff changeset
63 Licence (MIT)
e32f2ea6a139 Uploaded
bgruening
parents: 0
diff changeset
64 =============
e32f2ea6a139 Uploaded
bgruening
parents: 0
diff changeset
65
e32f2ea6a139 Uploaded
bgruening
parents: 0
diff changeset
66 Permission is hereby granted, free of charge, to any person obtaining a copy
e32f2ea6a139 Uploaded
bgruening
parents: 0
diff changeset
67 of this software and associated documentation files (the "Software"), to deal
e32f2ea6a139 Uploaded
bgruening
parents: 0
diff changeset
68 in the Software without restriction, including without limitation the rights
e32f2ea6a139 Uploaded
bgruening
parents: 0
diff changeset
69 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
e32f2ea6a139 Uploaded
bgruening
parents: 0
diff changeset
70 copies of the Software, and to permit persons to whom the Software is
e32f2ea6a139 Uploaded
bgruening
parents: 0
diff changeset
71 furnished to do so, subject to the following conditions:
0
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
72
1
e32f2ea6a139 Uploaded
bgruening
parents: 0
diff changeset
73 The above copyright notice and this permission notice shall be included in
e32f2ea6a139 Uploaded
bgruening
parents: 0
diff changeset
74 all copies or substantial portions of the Software.
0
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
75
1
e32f2ea6a139 Uploaded
bgruening
parents: 0
diff changeset
76 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
e32f2ea6a139 Uploaded
bgruening
parents: 0
diff changeset
77 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
e32f2ea6a139 Uploaded
bgruening
parents: 0
diff changeset
78 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
e32f2ea6a139 Uploaded
bgruening
parents: 0
diff changeset
79 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
e32f2ea6a139 Uploaded
bgruening
parents: 0
diff changeset
80 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
e32f2ea6a139 Uploaded
bgruening
parents: 0
diff changeset
81 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
e32f2ea6a139 Uploaded
bgruening
parents: 0
diff changeset
82 THE SOFTWARE.
0
82547f0d3a29 Initial interproscan5 wrapper.
bgruening
parents:
diff changeset
83