Mercurial > repos > crs4 > prokka

diff readme.rst @ 2:4bafaa074484 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Merge with Lionel Guy's wrapper. Directly call prokka, remove prokka.py . Add locustag, increment, gffver, compliant, addgenes, genus, species, strain, plasmid, gcode, usegenus, metagenome, fast, evalue, norrna, notrna params. Update BLAST+ dependency to 2.2.28. Add dependencies on prodigal and barrnap. Add readme.rst .
author crs4
date Fri, 25 Oct 2013 08:59:51 -0400
parents
children fffa1ae330ae
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/readme.rst	Fri Oct 25 08:59:51 2013 -0400
@@ -0,0 +1,35 @@
+Prokka wrapper
+==============
+
+Warning
+-------
+
+Prokka includes custom databases and is thus about a 2.0 GB download!
+
+Dependencies of Prokka which needs to be installed separately
+-------------------------------------------------------------
+
+- Perl core modules: File\::Copy, FindBin, Getopt::Long, List::Util, Scalar::Util, Time::Piece, Time::Seconds;
+- Perl modules: Bio::SeqIO from BioPerl_ >= 1.6.900, `XML::Simple`_;
+- `GNU Parallel`_ >= 20130422 is required, but is shipped with Prokka and thus is not managed by the tool dependency system;
+- tbl2asn_ >= 21.0 is required. This dependency is not managed here since versions are increasing very rapidly;
+- SignalP_ >= 3.0 is an optional dependency to find signal peptides. For licensing reasons, it is not used in the tool wrapper.
+
+.. _BioPerl: http://search.cpan.org/dist/BioPerl/
+.. _XML::Simple: http://search.cpan.org/dist/XML-Simple/
+.. _GNU Parallel: http://www.gnu.org/software/parallel/
+.. _tbl2asn: http://www.ncbi.nlm.nih.gov/genbank/tbl2asn2/
+.. _SignalP: http://www.cbs.dtu.dk/services/SignalP/
+
+Configuration
+-------------
+
+Change the PROKKA_SITE_OPTIONS variable in the installed env.sh file to adjust the number of CPUs to use (--cpus).
+
+Version history
+---------------
+
+- v0.1 (LG): initial release in the toolshed, supports Prokka 1.6.
+- v0.2 (LG): added this readme file, supports Prokka 1.7, and adds dependencies management.
+- v1.1.0: merge the wrappers by CRS4 and Lionel Guy, add COPYING file with MIT license, make all params optional, add gffver param, correctly quote text params in command, use float type for 'evalue' param, describe output files in help, upgrade BLAST+ dependency to version 2.2.28, depend on package_aragorn_1_2_36 instead of trna_prediction, depend on package_prodigal_2_60 instead of prodigal, depend on package_barrnap_0_2 instead of barrnap, add PROKKA_SITE_OPTIONS to env.sh and remove 'cpus' param.
+