annotate readme.txt @ 22:225d40beff1a draft

Uploaded
author bgruening
date Mon, 14 Oct 2013 03:26:11 -0400
parents 9b91d26ee080
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
1 Galaxy wrapper for AntiSmash
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
2 =====================================
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
3
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
4 This wrapper is copyright 2012 by Björn Grüning.
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
5
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
6 This is a wrapper for the command line tool of antiSMASH.
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
7
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
8 antiSMASH allows the rapid genome-wide identification, annotation and analysis of secondary metabolite biosynthesis gene clusters in bacterial and fungal genomes.
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
9 It integrates and cross-links with a large number of in silico secondary metabolite analysis tools.
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
10
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
11 http://antismash.secondarymetabolites.org/
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
12
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
13 Marnix H. Medema, Kai Blin, Peter Cimermancic, Victor de Jager, Piotr Zakrzewski, Michael A. Fischbach, Tilmann Weber, Rainer Breitling & Eriko Takano (2011).
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
14 antiSMASH: Rapid identification, annotation and analysis of secondary metabolite biosynthesis gene clusters. Nucleic Acids Research 39: W339-W346.
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
15
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
16
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
17 Installation
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
18 ============
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
19
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
20 Currently these wrapper is tested with version 1.1 and the modified version of antismash.py included in that repository.
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
21
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
22 Install or downlaod antiSMASH from:
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
23
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
24
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
25 https://bitbucket.org/antismash/antismash2/downloads/antismash-2.0.2.x86_64.tar.bz2
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
26
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
27
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
28 ... and follow the instructions.
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
29 Please replace the antismash.py file with the one inlcuded in that repository.
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
30 Edit the following lines in multi_antiSMASH_wrapper.py and antiSMASH_wrapper.py and adopt it to your installation.
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
31
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
32 blastdbpath = '/home/galaxy/bin/antismash-1.1.0/db'
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
33 pfamdbpath = '/home/galaxy/bin/antismash-1.1.0/db'
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
34 antismash_path = '/home/galaxy/bin/antismash-1.1.0/antismash.py'
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
35
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
36
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
37 To install the wrapper copy the antiSMASH folder in the galaxy tools
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
38 folder and modify the tools_conf.xml file to make the tool available to Galaxy.
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
39 For example:
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
40
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
41 <section name="PKS-NRPS prediction" id="pks-nrps_prediction">
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
42 <tool file="pks-nrps/tools/antiSMASH/antiSMASH.xml" />
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
43 <tool file="pks-nrps/tools/antiSMASH/multi_antiSMASH.xml" />
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
44 </section>
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
45
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
46
4
9b91d26ee080 Uploaded
bgruening
parents: 0
diff changeset
47 external Data
9b91d26ee080 Uploaded
bgruening
parents: 0
diff changeset
48 =============
9b91d26ee080 Uploaded
bgruening
parents: 0
diff changeset
49
9b91d26ee080 Uploaded
bgruening
parents: 0
diff changeset
50 The antismash.loc file contains the path to a PFAM database.
9b91d26ee080 Uploaded
bgruening
parents: 0
diff changeset
51 For any other tool that also uses a PFAM database *.log file, you can sync or link both *.loc files.
9b91d26ee080 Uploaded
bgruening
parents: 0
diff changeset
52
9b91d26ee080 Uploaded
bgruening
parents: 0
diff changeset
53
9b91d26ee080 Uploaded
bgruening
parents: 0
diff changeset
54
0
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
55 History
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
56 =======
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
57
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
58 v0.1 - Initial public release
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
59
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
60
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
61 Wrapper Licence (MIT/BSD style)
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
62 ===============================
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
63
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
64 Permission to use, copy, modify, and distribute this software and its
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
65 documentation with or without modifications and for any purpose and
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
66 without fee is hereby granted, provided that any copyright notices
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
67 appear in all copies and that both those copyright notices and this
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
68 permission notice appear in supporting documentation, and that the
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
69 names of the contributors or copyright holders not be used in
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
70 advertising or publicity pertaining to distribution of the software
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
71 without specific prior permission.
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
72
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
73 THE CONTRIBUTORS AND COPYRIGHT HOLDERS OF THIS SOFTWARE DISCLAIM ALL
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
74 WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
75 WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
76 CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
77 OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
78 OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
79 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
80 OR PERFORMANCE OF THIS SOFTWARE.
7ad005dfbe78 Uploaded
bgruening
parents:
diff changeset
81