annotate readme.txt @ 0:6a37d0a4510a default tip

initial uploaded
author bjoern-gruening
date Thu, 15 Mar 2012 05:23:03 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
1 Galaxy wrapper for AntiSmash
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
2 =====================================
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
3
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
4 This wrapper is copyright 2012 by Björn Grüning.
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
5
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
6 This is a wrapper for the command line tool of antiSMASH.
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
7
6a37d0a4510a initial uploaded
bjoern-gruening
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.
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
9 It integrates and cross-links with a large number of in silico secondary metabolite analysis tools.
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
10
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
11 http://antismash.secondarymetabolites.org/
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
12
6a37d0a4510a initial uploaded
bjoern-gruening
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).
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
14 antiSMASH: Rapid identification, annotation and analysis of secondary metabolite biosynthesis gene clusters. Nucleic Acids Research 39: W339-W346.
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
15
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
16
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
17 Installation
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
18 ============
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
19
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
20 Currently these wrapper is tested with version 1.1 and the modified version of antismash.py included in that repository.
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
21
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
22 Install or downlaod antiSMASH from:
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
23
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
24 http://antismash.secondarymetabolites.org/download.html
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
25
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
26 ... and follow the instructions.
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
27 Please replace the antismash.py file with the one inlcuded in that repository.
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
28 Edit the following lines in multi_antiSMASH_wrapper.py and antiSMASH_wrapper.py and adopt it to your installation.
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
29
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
30 blastdbpath = '/home/galaxy/bin/antismash-1.1.0/db'
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
31 pfamdbpath = '/home/galaxy/bin/antismash-1.1.0/db'
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
32 antismash_path = '/home/galaxy/bin/antismash-1.1.0/antismash.py'
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
33
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
34
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
35 To install the wrapper copy the antiSMASH folder in the galaxy tools
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
36 folder and modify the tools_conf.xml file to make the tool available to Galaxy.
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
37 For example:
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
38
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
39 <section name="PKS-NRPS prediction" id="pks-nrps_prediction">
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
40 <tool file="pks-nrps/tools/antiSMASH/antiSMASH.xml" />
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
41 <tool file="pks-nrps/tools/antiSMASH/multi_antiSMASH.xml" />
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
42 </section>
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
43
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
44
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
45 History
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
46 =======
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
47
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
48 v0.1 - Initial public release
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
49
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
50
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
51 Wrapper Licence (MIT/BSD style)
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
52 ===============================
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
53
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
54 Permission to use, copy, modify, and distribute this software and its
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
55 documentation with or without modifications and for any purpose and
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
56 without fee is hereby granted, provided that any copyright notices
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
57 appear in all copies and that both those copyright notices and this
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
58 permission notice appear in supporting documentation, and that the
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
59 names of the contributors or copyright holders not be used in
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
60 advertising or publicity pertaining to distribution of the software
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
61 without specific prior permission.
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
62
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
63 THE CONTRIBUTORS AND COPYRIGHT HOLDERS OF THIS SOFTWARE DISCLAIM ALL
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
64 WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
65 WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
66 CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
67 OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
68 OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
69 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
70 OR PERFORMANCE OF THIS SOFTWARE.
6a37d0a4510a initial uploaded
bjoern-gruening
parents:
diff changeset
71