annotate barrnap.xml @ 0:8fd427007e93 draft

planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
author iuc
date Mon, 28 Aug 2017 14:14:41 -0400
parents
children 7355bbf5e05f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
1 <tool id="barrnap" name="barrnap" version="1.2.0">
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
2 <description>Locate ribosomal RNA's in a fasta file. (GFF output)</description>
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
3 <requirements>
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
4 <requirement type="package" version="0.8">barrnap</requirement>
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
5 </requirements>
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
6 <version_command>barrnap --version</version_command>
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
7 <command detect_errors="exit_code"><![CDATA[
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
8 barrnap
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
9 --quiet
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
10 --threads \${GALAXY_SLOTS:-1}
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
11 --reject $reject
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
12 --lencutoff $lencutoff
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
13 --evalue $evalue
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
14 #if $incseq
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
15 --incseq
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
16 #end if
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
17 --kingdom $kingdom
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
18 '$fasta_file'
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
19 > '$gff'
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
20 ]]>
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
21 </command>
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
22
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
23 <inputs>
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
24 <param name="fasta_file" type="data" format="fasta" label="Fasta file" help="Fasta file to look for rRNA's in" />
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
25 <param name="kingdom" type="select" label="Kingdom">
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
26 <option value="bac" selected="true">Bacteria</option>
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
27 <option value="euk">Eukaryote</option>
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
28 <option value="mito">Mitochondria</option>
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
29 <option value="arc">Archaea</option>
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
30 </param>
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
31 <param name="reject" type="float" value="0.5" label="Reject length threshold" help="Proportional length threshold to reject prediction" />
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
32 <param name="lencutoff" type="float" value="0.8" label="Length cutoff" help="Proportional length threshold to tag a find as pseudo" />
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
33 <param name="evalue" type="float" value="1e-06" label="e-value" help="Similarity e-value cutoff" />
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
34 <param name="incseq" type="boolean" label="Include Sequences in GFF" help="Include the fasta sequences in the GFF output file" />
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
35 </inputs>
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
36
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
37 <outputs>
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
38 <data name="gff" format="gff3" label="${tool.name} on ${on_string}: rRNA GFF"/>
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
39 </outputs>
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
40
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
41 <tests>
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
42 <test><!-- Test 1 -->
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
43 <param name="fasta_file" value="bacteria.fna" ftype="fasta" />
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
44 <param name="kingdom" value="bac" />
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
45 <output name="gff" value="test_1.gff" ftype="gff3" />
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
46 </test>
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
47 <test> <!-- Test 2 -->
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
48 <param name="fasta_file" value="small.fna" ftype="fasta" />
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
49 <param name="kingdom" value="bac" />
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
50 <param name="incseq" value="true" />
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
51 <output name="gff" value="test_2.gff" ftype="gff3" />
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
52 </test>
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
53 <test> <!-- Test 3 -->
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
54 <param name="fasta_file" value="small.fna" ftype="fasta" />
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
55 <param name="kingdom" value="bac" />
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
56 <param name="evalue" value="0.00000001" />
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
57 <output name="gff" value="test_3.gff" ftype="gff3" />
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
58 </test>
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
59 </tests>
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
60
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
61 <help>
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
62
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
63 **barrnap**
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
64
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
65 barrnap_ predicts the location of 5S, 16S and 23S ribosomal RNA genes in Bacterial genome sequences. Barrnap now supports Archaea, Eukaryota and Mitochondria. It takes FASTA DNA sequence as input, and write GFF3 as output. It uses the new NHMMER tool that comes with HMMER 3.1-dev for HMM searching in DNA:DNA style. NHMMER binaries for 64-bit Linux and Mac OS X are included and will be auto-detected. Multithreading is supported and one can expect roughly linear speed-ups with more CPUs.
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
66 This tool is designed to be a substitute for RNAmmer. It was motivated by my desire to remove Prokka's dependency on RNAmmer which is encumbered by an free-for-academic sign-up license, and by the needed legacy HMMER 2.x which conflicts with HMMER 3.x that most people are using now.
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
67
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
68 RNAmmer is more sophisticated than Barrnap, and more accurate. because it uses HMMER 2.x in glocal alignment mode, whereas HMMER 3.x currently only supports local alignment (Sean Eddy expects glocal to be supported in 2014). In practice, Barrnap will find all the typical 5/16/23S genes in bacteria, but may get the end points out by a few bases and will probably miss wierd rRNAs. The HMM models it uses are derived from RFAM, Silva, and GreenGenes.
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
69
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
70 The name Barrnap is derived from BActerial Ribosomal RNA Predictor. It was spawned at CodeFest 2013 in Berlin, Germany by Torsten Seemann and Tim Booth.
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
71
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
72 .. _barrnap: https://github.com/tseemann/barrnap
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
73
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
74 **Inputs/Parameters**
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
75
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
76 *Fasta file*: The fasta file whose contents you want to search for ribosomal RNA's.
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
77
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
78 *Kingdom*: Select the Kingdom of the organism: Bacteria, Eukarote, Mitochondria or Archaea.
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
79
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
80 *Length cutoff*: Proportional length threshold to tag a possible rRNA as pseudo.
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
81
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
82 *Reject length threshold*: Proportional length threshold to reject prediction
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
83
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
84 *E-value*: Similarity cutoff e-value.
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
85
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
86 *Include Sequences in GFF*: This includes the original fasta sequence in the GFF file below the #FASTA tag
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
87
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
88 </help>
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
89 <citations>
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
90 <citation type="bibtex">@UNPUBLISHED{Seemann2013,
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
91 author = "Torsten Seemann",
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
92 title = "barrnap 0.8 : rapid ribosomal RNA prediction",
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
93 year = "2013",
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
94 note = "https://github.com/tseemann/barrnap"}
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
95 </citation>
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
96 </citations>
8fd427007e93 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
97 </tool>