Mercurial > repos > lionelguy > prokka

annotate readme.rst @ 2:bb07951d72db draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Corrected some typos in dependency names
author lionelguy
date Wed, 04 Sep 2013 11:35:45 -0400
parents 2bb7c28ea68f
children 563743fcaae1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
1 Prokka wrapper
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
2 ==============
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
3
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
4 Warning
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
5 -------
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
6
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
7 Prokka comes with custom databases and is thus very large: **~2Gb**!
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
8
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
9 Note
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
10 ----
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
11
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
12 - **infernal** >= 1.1rc4 is an optional dependency to find non-coding RNAs. An executable is shipped with prokka.
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
13 - **SignalP** >= 3.0 is an optional dependency to find signal peptides. For licensing reasons, no automatic dependency is managed.
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
14 - **tbl2asn** >= 21.0 is required. This dependency is not managed here. The reason is that versions are increasing very rapidly. The software can be downloaded from the NCBI (ftp) at the following address.
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
15 ftp://ftp.ncbi.nih.gov/toolbox/ncbi_tools/converters/by_program/tbl2asn/
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
16 - **BioPerl** >= 1.6 is required, but the dependency is not managed here, although it might in future.
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
17 - **GNU Parallel** >= 20120322 is required but is shipped with Prokka and thus is not managed by the tool dependency system
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
18
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
19 Version history
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
20 ---------------
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
21
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
22 - v0.2: added this readme file, supports prokka 1.7 and adds dependencies management.
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
23 - v0.1: initial release in the toolshed, supports prokka 1.6.
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
24
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
25
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
26 Copyright
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
27 ---------
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
28
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
29 prokka is developed by Torsten Seemann at Victorian Bioinformatics Consortium http://www.bioinformatics.net.au/. prokka is released under GPLv3 or later.
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
30
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
31 This wrapper is copyrighted by Lionel Guy, and is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
32
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
33 This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
34
2bb7c28ea68f Committed version 0.2: added dependency management and a readme file, and support prokka 1.7
lionelguy
parents:
diff changeset
35 You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.