annotate prokka.xml @ 1:4b6f16a79fe4 draft

Add txt output file. Use a definition list instead of a block quote in <help>. Correct 2 dependency minimum versions.
author crs4
date Thu, 26 Sep 2013 12:39:52 -0400
parents 95505a9fa26f
children 4bafaa074484
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
1 <tool id="prokka" name="Prokka" version="1.0.1">
0
95505a9fa26f Uploaded
crs4
parents:
diff changeset
2 <description>Prokaryotic Annotation</description>
95505a9fa26f Uploaded
crs4
parents:
diff changeset
3 <requirements>
95505a9fa26f Uploaded
crs4
parents:
diff changeset
4 <requirement type="package" version="2.2.26+">blast+</requirement>
95505a9fa26f Uploaded
crs4
parents:
diff changeset
5 <requirement type="package" version="3.1b1">hmmer</requirement>
95505a9fa26f Uploaded
crs4
parents:
diff changeset
6 <requirement type="package" version="1.2.36">aragorn</requirement>
95505a9fa26f Uploaded
crs4
parents:
diff changeset
7 <requirement type="package" version="1.1rc4">infernal</requirement>
95505a9fa26f Uploaded
crs4
parents:
diff changeset
8 <requirement type="package" version="1.7">prokka</requirement>
95505a9fa26f Uploaded
crs4
parents:
diff changeset
9 </requirements>
95505a9fa26f Uploaded
crs4
parents:
diff changeset
10 <version_command>prokka --version</version_command>
95505a9fa26f Uploaded
crs4
parents:
diff changeset
11 <command interpreter="python">
95505a9fa26f Uploaded
crs4
parents:
diff changeset
12 prokka.py
95505a9fa26f Uploaded
crs4
parents:
diff changeset
13 \${PROKKA_SITE_OPTIONS:---cpus 8}
95505a9fa26f Uploaded
crs4
parents:
diff changeset
14 ## Reads in FASTA format
95505a9fa26f Uploaded
crs4
parents:
diff changeset
15 --fasta=$fasta_file
95505a9fa26f Uploaded
crs4
parents:
diff changeset
16 ## Additional inputs
95505a9fa26f Uploaded
crs4
parents:
diff changeset
17 --kingdom $kingdom_type.kingdom
95505a9fa26f Uploaded
crs4
parents:
diff changeset
18 #if str($mincontig)
95505a9fa26f Uploaded
crs4
parents:
diff changeset
19 --mincontig $mincontig
95505a9fa26f Uploaded
crs4
parents:
diff changeset
20 #end if
95505a9fa26f Uploaded
crs4
parents:
diff changeset
21 #if $rfam
95505a9fa26f Uploaded
crs4
parents:
diff changeset
22 --rfam
95505a9fa26f Uploaded
crs4
parents:
diff changeset
23 #end if
95505a9fa26f Uploaded
crs4
parents:
diff changeset
24 #if $centre
95505a9fa26f Uploaded
crs4
parents:
diff changeset
25 --centre "$centre"
95505a9fa26f Uploaded
crs4
parents:
diff changeset
26 #end if
95505a9fa26f Uploaded
crs4
parents:
diff changeset
27 ## Output files
95505a9fa26f Uploaded
crs4
parents:
diff changeset
28 --gff=$out_gff
95505a9fa26f Uploaded
crs4
parents:
diff changeset
29 --gbk=$out_gbk
95505a9fa26f Uploaded
crs4
parents:
diff changeset
30 --fna=$out_fna
95505a9fa26f Uploaded
crs4
parents:
diff changeset
31 --faa=$out_faa
95505a9fa26f Uploaded
crs4
parents:
diff changeset
32 --ffn=$out_ffn
95505a9fa26f Uploaded
crs4
parents:
diff changeset
33 --sqn=$out_sqn
95505a9fa26f Uploaded
crs4
parents:
diff changeset
34 --fsa=$out_fsa
95505a9fa26f Uploaded
crs4
parents:
diff changeset
35 --tbl=$out_tbl
95505a9fa26f Uploaded
crs4
parents:
diff changeset
36 --err=$out_err
1
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
37 --txt=$out_txt
0
95505a9fa26f Uploaded
crs4
parents:
diff changeset
38 --log=$out_log
95505a9fa26f Uploaded
crs4
parents:
diff changeset
39 </command>
95505a9fa26f Uploaded
crs4
parents:
diff changeset
40 <inputs>
95505a9fa26f Uploaded
crs4
parents:
diff changeset
41 <param name="fasta_file" type="data" format="fasta" label="Contigs" help="FASTA format" />
95505a9fa26f Uploaded
crs4
parents:
diff changeset
42 <conditional name="kingdom_type">
95505a9fa26f Uploaded
crs4
parents:
diff changeset
43 <param name="kingdom" type="select" label="Kingdom (--kingdom)">
95505a9fa26f Uploaded
crs4
parents:
diff changeset
44 <option value="Archaea">Archaea</option>
95505a9fa26f Uploaded
crs4
parents:
diff changeset
45 <option value="Bacteria" selected="true">Bacteria</option>
95505a9fa26f Uploaded
crs4
parents:
diff changeset
46 <option value="Viruses">Viruses</option>
95505a9fa26f Uploaded
crs4
parents:
diff changeset
47 </param>
95505a9fa26f Uploaded
crs4
parents:
diff changeset
48 <when value="Archaea" />
95505a9fa26f Uploaded
crs4
parents:
diff changeset
49 <when value="Bacteria" />
95505a9fa26f Uploaded
crs4
parents:
diff changeset
50 <when value="Viruses" />
95505a9fa26f Uploaded
crs4
parents:
diff changeset
51 </conditional>
95505a9fa26f Uploaded
crs4
parents:
diff changeset
52 <param name="mincontig" type="integer" value="200" optional="true" label="Minimun contig size - NCBI needs 200 (--mincontig)" />
95505a9fa26f Uploaded
crs4
parents:
diff changeset
53 <param name="centre" type="text" value="CRS4" label="Sequencing centre ID (--centre)" />
95505a9fa26f Uploaded
crs4
parents:
diff changeset
54 <param name="rfam" type="boolean" checked="false" label="Enable searching for ncRNAs with Infernal-Rfam - SLOW (--rfam)" />
95505a9fa26f Uploaded
crs4
parents:
diff changeset
55 </inputs>
95505a9fa26f Uploaded
crs4
parents:
diff changeset
56 <outputs>
1
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
57 <data format="gff" name="out_gff" label="${tool.name} on ${on_string}: gff" />
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
58 <data format="txt" name="out_gbk" label="${tool.name} on ${on_string}: gbk" />
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
59 <data format="fasta" name="out_fna" label="${tool.name} on ${on_string}: fna" />
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
60 <data format="fasta" name="out_faa" label="${tool.name} on ${on_string}: faa" />
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
61 <data format="fasta" name="out_ffn" label="${tool.name} on ${on_string}: ffn" />
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
62 <data format="asn1" name="out_sqn" label="${tool.name} on ${on_string}: sqn" />
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
63 <data format="fasta" name="out_fsa" label="${tool.name} on ${on_string}: fsa" />
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
64 <data format="txt" name="out_tbl" label="${tool.name} on ${on_string}: tbl" />
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
65 <data format="txt" name="out_err" label="${tool.name} on ${on_string}: err" />
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
66 <data format="txt" name="out_txt" label="${tool.name} on ${on_string}: txt" />
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
67 <data format="txt" name="out_log" label="${tool.name} on ${on_string}: log" />
0
95505a9fa26f Uploaded
crs4
parents:
diff changeset
68 </outputs>
95505a9fa26f Uploaded
crs4
parents:
diff changeset
69
95505a9fa26f Uploaded
crs4
parents:
diff changeset
70 <help>
95505a9fa26f Uploaded
crs4
parents:
diff changeset
71 **What it does**
95505a9fa26f Uploaded
crs4
parents:
diff changeset
72
1
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
73 Prokka_ is a software tool to annotate bacterial, archaeal and viral genomes very rapidly, and produce output files that require only minor tweaking to submit to GenBank/ENA/DDBJ.
0
95505a9fa26f Uploaded
crs4
parents:
diff changeset
74
95505a9fa26f Uploaded
crs4
parents:
diff changeset
75 .. _Prokka: http://www.vicbioinformatics.com/software.prokka.shtml
95505a9fa26f Uploaded
crs4
parents:
diff changeset
76
95505a9fa26f Uploaded
crs4
parents:
diff changeset
77 **Output files**
95505a9fa26f Uploaded
crs4
parents:
diff changeset
78
1
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
79 Prokka creates several output files:
0
95505a9fa26f Uploaded
crs4
parents:
diff changeset
80
1
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
81 gff
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
82 This is the master annotation in GFF3 format, containing both sequences and annotations
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
83 gbk
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
84 This is a standard GenBank file derived from the master .gff . If the input to prokka was a multi-FASTA, then this will be a multi-GenBank, with one record for each sequence
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
85 fna
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
86 Nucleotide FASTA file of the input contig sequences
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
87 faa
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
88 Protein FASTA file of the translated CDS sequences
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
89 ffn
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
90 Nucleotide FASTA file of all the annotated sequences, not just CDS
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
91 sqn
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
92 An ASN1 format "Sequin" file for submission to GenBank. It needs to be edited to set the correct taxonomy, authors, related publication, etc.
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
93 fsa
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
94 Nucleotide FASTA file of the input contig sequences, used by "tbl2asn" to create the .sqn file. It is mostly the same as the .fna file, but with extra Sequin tags in the sequence description lines
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
95 tbl
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
96 Feature Table file, used by "tbl2asn" to create the .sqn file
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
97 err
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
98 Unacceptable annotations - the NCBI discrepancy report
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
99 log
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
100 Contains all the output that Prokka produced during its run
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
101 txt
4b6f16a79fe4 Add txt output file.
crs4
parents: 0
diff changeset
102 Statistics relating to the annotated features found
0
95505a9fa26f Uploaded
crs4
parents:
diff changeset
103
95505a9fa26f Uploaded
crs4
parents:
diff changeset
104 **License and citation**
95505a9fa26f Uploaded
crs4
parents:
diff changeset
105
95505a9fa26f Uploaded
crs4
parents:
diff changeset
106 This Galaxy tool is Copyright © 2013 `CRS4 Srl.`_ and is released under the `MIT license`_.
95505a9fa26f Uploaded
crs4
parents:
diff changeset
107
95505a9fa26f Uploaded
crs4
parents:
diff changeset
108 .. _CRS4 Srl.: http://www.crs4.it/
95505a9fa26f Uploaded
crs4
parents:
diff changeset
109 .. _MIT license: http://opensource.org/licenses/MIT
95505a9fa26f Uploaded
crs4
parents:
diff changeset
110
95505a9fa26f Uploaded
crs4
parents:
diff changeset
111 If you use this tool in Galaxy, please cite |Cuccuru2013|_.
95505a9fa26f Uploaded
crs4
parents:
diff changeset
112
95505a9fa26f Uploaded
crs4
parents:
diff changeset
113 .. |Cuccuru2013| replace:: Cuccuru, G., Orsini, M., Pinna, A., Sbardellati, A., Soranzo, N., Travaglione, A., Uva, P., Zanetti, G., Fotia, G. (2013) Orione, a web-based framework for NGS analysis in microbiology. *Submitted*
95505a9fa26f Uploaded
crs4
parents:
diff changeset
114 .. _Cuccuru2013: http://orione.crs4.it/
95505a9fa26f Uploaded
crs4
parents:
diff changeset
115
95505a9fa26f Uploaded
crs4
parents:
diff changeset
116 This tool uses `Prokka`_, which is licensed separately. Please cite Seemann T. Prokka: Prokaryotic Genome Annotation System (in preparation).
95505a9fa26f Uploaded
crs4
parents:
diff changeset
117
95505a9fa26f Uploaded
crs4
parents:
diff changeset
118 .. _Prokka: http://www.vicbioinformatics.com/software.prokka.shtml
95505a9fa26f Uploaded
crs4
parents:
diff changeset
119 </help>
95505a9fa26f Uploaded
crs4
parents:
diff changeset
120 </tool>