annotate readme.rst @ 0:5db064bbb3be draft

Imported from capsule None
author bgruening
date Tue, 15 Jul 2014 14:34:55 -0400
parents
children 593bb8f5488b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
1 Galaxy wrapper for AntiSmash
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
2 =====================================
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
3
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
4 This wrapper is copyright 2012-2014 by Björn Grüning.
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
5
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
6 This is a wrapper for the command line tool of antiSMASH.
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
7
5db064bbb3be Imported from capsule None
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.
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
9 It integrates and cross-links with a large number of in silico secondary metabolite analysis tools.
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
10
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
11 http://antismash.secondarymetabolites.org/
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
12
5db064bbb3be Imported from capsule None
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).
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
14 antiSMASH: Rapid identification, annotation and analysis of secondary metabolite biosynthesis gene clusters. Nucleic Acids Research 39: W339-W346.
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
15
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
16
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
17 Installation
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
18 ============
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
19
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
20 Galaxy should be able to automatically install the dependencies, i.e. the
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
21 'package_hmmer_3_0' or 'package_blast_plus_2_2_28' repository.
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
22
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
23 You must tell Galaxy about any system level Pfam databases using the configuration
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
24 file antismash.loc.
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
25
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
26 You can download the Pfam provided databases as compressed archives from here:
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
27
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
28 * ftp://ftp.sanger.ac.uk/pub/databases/Pfam/current_release/
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
29
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
30
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
31 External Data
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
32 =============
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
33
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
34 The antismash.loc file contains the path to a Pfam database.
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
35 For any other tool that also uses a Pfam database *.log file, you can sync or link both *.loc files.
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
36
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
37
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
38
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
39 History
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
40 =======
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
41
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
42 v0.1 - Initial public release
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
43
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
44
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
45 Licence (MIT)
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
46 =============
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
47
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
48 Permission is hereby granted, free of charge, to any person obtaining a copy
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
49 of this software and associated documentation files (the "Software"), to deal
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
50 in the Software without restriction, including without limitation the rights
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
51 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
52 copies of the Software, and to permit persons to whom the Software is
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
53 furnished to do so, subject to the following conditions:
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
54
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
55 The above copyright notice and this permission notice shall be included in
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
56 all copies or substantial portions of the Software.
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
57
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
58 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
59 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
60 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
61 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
62 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
63 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
64 THE SOFTWARE.
5db064bbb3be Imported from capsule None
bgruening
parents:
diff changeset
65