annotate readme.rst @ 0:de422ef8527d draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
author iuc
date Fri, 28 Oct 2016 12:37:17 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
1 Prokka wrapper
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
2 ==============
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
3
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
4 Warning
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
5 -------
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
6
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
7 Prokka includes custom databases and is thus about a 340 MB download!
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
8
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
9 Dependencies of Prokka which need to be installed separately
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
10 -------------------------------------------------------------
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
11
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
12 - Perl core modules: File\::Copy, FindBin, Getopt::Long, List::Util, Scalar::Util, Time::Piece, Time::Seconds;
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
13 - Perl modules: Bio::SeqIO from BioPerl_ >= 1.6.900, `XML::Simple`_;
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
14 - SignalP_ >= 3.0 is an optional dependency to find signal peptides. For licensing reasons, it is not used in the tool wrapper.
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
15
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
16 .. _BioPerl: http://search.cpan.org/dist/BioPerl/
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
17 .. _XML::Simple: http://search.cpan.org/dist/XML-Simple/
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
18 .. _SignalP: http://www.cbs.dtu.dk/services/SignalP/
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
19
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
20 Version history
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
21 ---------------
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
22
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
23 - Release 7 (prokka 1.11.0): Support Prokka 1.11. Upgrade dependencies to package_barrnap_0_7, package_blast_plus_2_2_31, package_hmmer_3_1b2, package_tbl2asn_24_3.
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
24 - Release 6 (prokka 1.4.0): Use <stdio> because prokka writes some warnings on stderr. Update Orione citation. Update Prokka citation. Support Prokka 1.10. Upgrade dependencies to package_minced_0_1_6, package_barrnap_0_5 and package_tbl2asn_23_7. Added --proteins option. Add <citations>.
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
25 - Release 5 (prokka 1.3.0): Fix Prokka 1.8 dependency installation.
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
26 - Release 4 (prokka 1.3.0): Support Prokka 1.8. Depend on package_minced_0_1_4 and package_tbl2asn_22_4 (requires Galaxy release_2013.11.04 or later). Update citation.
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
27 - Release 3 (prokka 1.2.0): Use $GALAXY_SLOTS instead of $PROKKA_SITE_OPTIONS. Upgrade Barrnap dependency to v. 0.3. Upgrade Infernal dependency to v. 1.1. Depend on package_gnu_parallel_20131122 (requires Galaxy release_2013.11.04 or later).
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
28 - Release 2 (prokka 1.1.0): Merge the wrappers by CRS4 and Lionel Guy. Directly call prokka, remove prokka.py . Add 'locustag', 'increment', 'gffver', 'compliant', 'addgenes', 'genus', 'species', 'strain', 'plasmid', 'gcode', 'usegenus', 'metagenome', 'fast', 'evalue', 'norrna', 'notrna' params. Upgrade BLAST+ dependency to v. 2.2.28. Add dependencies on prodigal and barrnap. Add readme.rst .
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
29 - Release 1 (prokka 1.0.1): Add txt output file. Use a definition list instead of a block quote in <help>. Correct 2 dependency minimum versions.
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
30 - Release 0 (prokka 1.0.0): Initial release in the Tool Shed.
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
31
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
32 Version history of (now deprecated) Lionel Guy's wrapper:
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
33
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
34 - prokka 1.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 v. 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.
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
35 - prokka 0.2: Added this readme file. Support Prokka 1.7. Add dependencies management.
de422ef8527d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/prokka/ commit 9a92d439f147a5cf2370e0686854911107de1144
iuc
parents:
diff changeset
36 - prokka 0.1: Initial release in the Tool Shed, supports Prokka 1.6.