Mercurial > repos > crs4 > prokka

annotate readme.rst @ 7:f5e44aad6498 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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.
author crs4
date Thu, 01 Oct 2015 14:14:06 -0400
parents 3ad7ef0ba385
children 392255fa7ab9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
4bafaa074484 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 .
crs4
parents:
diff changeset
1 Prokka wrapper
4bafaa074484 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 .
crs4
parents:
diff changeset
2 ==============
4bafaa074484 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 .
crs4
parents:
diff changeset
3
4bafaa074484 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 .
crs4
parents:
diff changeset
4 Warning
4bafaa074484 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 .
crs4
parents:
diff changeset
5 -------
4bafaa074484 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 .
crs4
parents:
diff changeset
6
6
3ad7ef0ba385 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>.
crs4
parents: 5
diff changeset
7 Prokka includes custom databases and is thus about a 340 MB download!
2
4bafaa074484 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 .
crs4
parents:
diff changeset
8
6
3ad7ef0ba385 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>.
crs4
parents: 5
diff changeset
9 Dependencies of Prokka which need to be installed separately
2
4bafaa074484 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 .
crs4
parents:
diff changeset
10 -------------------------------------------------------------
4bafaa074484 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 .
crs4
parents:
diff changeset
11
4bafaa074484 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 .
crs4
parents:
diff changeset
12 - Perl core modules: File\::Copy, FindBin, Getopt::Long, List::Util, Scalar::Util, Time::Piece, Time::Seconds;
4bafaa074484 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 .
crs4
parents:
diff changeset
13 - Perl modules: Bio::SeqIO from BioPerl_ >= 1.6.900, `XML::Simple`_;
4bafaa074484 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 .
crs4
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.
4bafaa074484 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 .
crs4
parents:
diff changeset
15
4bafaa074484 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 .
crs4
parents:
diff changeset
16 .. _BioPerl: http://search.cpan.org/dist/BioPerl/
4bafaa074484 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 .
crs4
parents:
diff changeset
17 .. _XML::Simple: http://search.cpan.org/dist/XML-Simple/
4bafaa074484 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 .
crs4
parents:
diff changeset
18 .. _SignalP: http://www.cbs.dtu.dk/services/SignalP/
4bafaa074484 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 .
crs4
parents:
diff changeset
19
4bafaa074484 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 .
crs4
parents:
diff changeset
20 Configuration
4bafaa074484 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 .
crs4
parents:
diff changeset
21 -------------
4bafaa074484 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 .
crs4
parents:
diff changeset
22
6
3ad7ef0ba385 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>.
crs4
parents: 5
diff changeset
23 prokka tool may be configured to use more than one CPU core by selecting an appropriate destination for this tool in Galaxy job_conf.xml file (see https://wiki.galaxyproject.org/Admin/Config/Jobs and https://wiki.galaxyproject.org/Admin/Config/Performance/Cluster ).
3
fffa1ae330ae 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).
crs4
parents: 2
diff changeset
24
4
5c0030f52b83 Support Prokka 1.8. Depend on package_minced_0_1_4 and package_tbl2asn_22_4 . Update citation.
crs4
parents: 3
diff changeset
25 If you are using Galaxy release_2013.11.04 or later, this tool will automatically use the number of CPU cores allocated by the job runner according to the configuration of the destination selected for this tool.
5c0030f52b83 Support Prokka 1.8. Depend on package_minced_0_1_4 and package_tbl2asn_22_4 . Update citation.
crs4
parents: 3
diff changeset
26
2
4bafaa074484 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 .
crs4
parents:
diff changeset
27 Version history
4bafaa074484 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 .
crs4
parents:
diff changeset
28 ---------------
4bafaa074484 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 .
crs4
parents:
diff changeset
29
7
f5e44aad6498 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.
crs4
parents: 6
diff changeset
30 - 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.
6
3ad7ef0ba385 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>.
crs4
parents: 5
diff changeset
31 - 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>.
5
b9fea998270a Fix Prokka 1.8 dependency installation.
crs4
parents: 4
diff changeset
32 - Release 5 (prokka 1.3.0): Fix Prokka 1.8 dependency installation.
4
5c0030f52b83 Support Prokka 1.8. Depend on package_minced_0_1_4 and package_tbl2asn_22_4 . Update citation.
crs4
parents: 3
diff changeset
33 - 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.
3
fffa1ae330ae 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).
crs4
parents: 2
diff changeset
34 - 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).
fffa1ae330ae 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).
crs4
parents: 2
diff changeset
35 - 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 .
fffa1ae330ae 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).
crs4
parents: 2
diff changeset
36 - 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.
fffa1ae330ae 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).
crs4
parents: 2
diff changeset
37 - Release 0 (prokka 1.0.0): Initial release in the Tool Shed.
fffa1ae330ae 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).
crs4
parents: 2
diff changeset
38
fffa1ae330ae 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).
crs4
parents: 2
diff changeset
39 Version history of (now deprecated) Lionel Guy's wrapper:
2
4bafaa074484 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 .
crs4
parents:
diff changeset
40
3
fffa1ae330ae 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).
crs4
parents: 2
diff changeset
41 - 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.
fffa1ae330ae 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).
crs4
parents: 2
diff changeset
42 - prokka 0.2: Added this readme file. Support Prokka 1.7. Add dependencies management.
fffa1ae330ae 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).
crs4
parents: 2
diff changeset
43 - prokka 0.1: Initial release in the Tool Shed, supports Prokka 1.6.
fffa1ae330ae 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).
crs4
parents: 2
diff changeset
44
fffa1ae330ae 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).
crs4
parents: 2
diff changeset
45 Development
fffa1ae330ae 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).
crs4
parents: 2
diff changeset
46 -----------
fffa1ae330ae 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).
crs4
parents: 2
diff changeset
47
fffa1ae330ae 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).
crs4
parents: 2
diff changeset
48 Development is hosted at https://bitbucket.org/crs4/orione-tools . Contributions and bug reports are very welcome!