annotate barrnap.xml @ 2:d465ebeb058f draft

"planemo upload commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
author iuc
date Mon, 30 Aug 2021 21:46:12 +0000
parents 21a7e1c0e072
children 0e85267c5167
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
21a7e1c0e072 planemo upload commit 19a431ffca44dd1fd61ba2b66e5fc5ca96364f81
iuc
parents: 0
diff changeset
1 <tool id="barrnap" name="barrnap" version="1.2.1">
0
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
2 <description>Locate ribosomal RNA's in a fasta file. (GFF output)</description>
2
d465ebeb058f "planemo upload commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 1
diff changeset
3 <xrefs>
d465ebeb058f "planemo upload commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 1
diff changeset
4 <xref type="bio.tools">barrnap</xref>
d465ebeb058f "planemo upload commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 1
diff changeset
5 </xrefs>
0
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
6 <requirements>
1
21a7e1c0e072 planemo upload commit 19a431ffca44dd1fd61ba2b66e5fc5ca96364f81
iuc
parents: 0
diff changeset
7 <requirement type="package" version="0.9">barrnap</requirement>
0
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
8 </requirements>
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
9 <version_command>barrnap --version</version_command>
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
10 <command detect_errors="exit_code"><![CDATA[
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
11 barrnap
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
12 --quiet
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
13 --threads \${GALAXY_SLOTS:-1}
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
14 --reject $reject
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
15 --lencutoff $lencutoff
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
16 --evalue $evalue
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
17 #if $incseq
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
18 --incseq
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
19 #end if
1
21a7e1c0e072 planemo upload commit 19a431ffca44dd1fd61ba2b66e5fc5ca96364f81
iuc
parents: 0
diff changeset
20 #if $outseq
21a7e1c0e072 planemo upload commit 19a431ffca44dd1fd61ba2b66e5fc5ca96364f81
iuc
parents: 0
diff changeset
21 --outseq '$fasta_out'
21a7e1c0e072 planemo upload commit 19a431ffca44dd1fd61ba2b66e5fc5ca96364f81
iuc
parents: 0
diff changeset
22 #end if
0
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
23 --kingdom $kingdom
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
24 '$fasta_file'
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
25 > '$gff'
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
26 ]]>
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
27 </command>
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
28
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
29 <inputs>
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
30 <param name="fasta_file" type="data" format="fasta" label="Fasta file" help="Fasta file to look for rRNA's in" />
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
31 <param name="kingdom" type="select" label="Kingdom">
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
32 <option value="bac" selected="true">Bacteria</option>
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
33 <option value="euk">Eukaryote</option>
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
34 <option value="mito">Mitochondria</option>
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
35 <option value="arc">Archaea</option>
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
36 </param>
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
37 <param name="reject" type="float" value="0.5" label="Reject length threshold" help="Proportional length threshold to reject prediction" />
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
38 <param name="lencutoff" type="float" value="0.8" label="Length cutoff" help="Proportional length threshold to tag a find as pseudo" />
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
39 <param name="evalue" type="float" value="1e-06" label="e-value" help="Similarity e-value cutoff" />
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
40 <param name="incseq" type="boolean" label="Include Sequences in GFF" help="Include the fasta sequences in the GFF output file" />
1
21a7e1c0e072 planemo upload commit 19a431ffca44dd1fd61ba2b66e5fc5ca96364f81
iuc
parents: 0
diff changeset
41 <param name="outseq" type="boolean" label="Save rRNA hit seqs as FASTA" help="Produce an output file of the rRNA sequences found in FASTA format." />
0
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
42 </inputs>
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
43
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
44 <outputs>
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
45 <data name="gff" format="gff3" label="${tool.name} on ${on_string}: rRNA GFF"/>
1
21a7e1c0e072 planemo upload commit 19a431ffca44dd1fd61ba2b66e5fc5ca96364f81
iuc
parents: 0
diff changeset
46 <data name="fasta_out" format="fasta" label="${tool.name} on ${on_string}: rRNA Sequences">
21a7e1c0e072 planemo upload commit 19a431ffca44dd1fd61ba2b66e5fc5ca96364f81
iuc
parents: 0
diff changeset
47 <filter>outseq</filter>
21a7e1c0e072 planemo upload commit 19a431ffca44dd1fd61ba2b66e5fc5ca96364f81
iuc
parents: 0
diff changeset
48 </data>
0
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
49 </outputs>
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
50
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
51 <tests>
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
52 <test><!-- Test 1 -->
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
53 <param name="fasta_file" value="bacteria.fna" ftype="fasta" />
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
54 <param name="kingdom" value="bac" />
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
55 <output name="gff" value="test_1.gff" ftype="gff3" />
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
56 </test>
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
57 <test> <!-- Test 2 -->
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
58 <param name="fasta_file" value="small.fna" ftype="fasta" />
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
59 <param name="kingdom" value="bac" />
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
60 <param name="incseq" value="true" />
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
61 <output name="gff" value="test_2.gff" ftype="gff3" />
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
62 </test>
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
63 <test> <!-- Test 3 -->
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
64 <param name="fasta_file" value="small.fna" ftype="fasta" />
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
65 <param name="kingdom" value="bac" />
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
66 <param name="evalue" value="0.00000001" />
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
67 <output name="gff" value="test_3.gff" ftype="gff3" />
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
68 </test>
1
21a7e1c0e072 planemo upload commit 19a431ffca44dd1fd61ba2b66e5fc5ca96364f81
iuc
parents: 0
diff changeset
69 <test><!-- Test 4 -->
21a7e1c0e072 planemo upload commit 19a431ffca44dd1fd61ba2b66e5fc5ca96364f81
iuc
parents: 0
diff changeset
70 <param name="fasta_file" value="small.fna" ftype="fasta" />
21a7e1c0e072 planemo upload commit 19a431ffca44dd1fd61ba2b66e5fc5ca96364f81
iuc
parents: 0
diff changeset
71 <param name="outseq" value="true" />
21a7e1c0e072 planemo upload commit 19a431ffca44dd1fd61ba2b66e5fc5ca96364f81
iuc
parents: 0
diff changeset
72 <param name="kingdom" value="bac" />
21a7e1c0e072 planemo upload commit 19a431ffca44dd1fd61ba2b66e5fc5ca96364f81
iuc
parents: 0
diff changeset
73 <output name="gff" value="test_4.gff" ftype="gff3" />
21a7e1c0e072 planemo upload commit 19a431ffca44dd1fd61ba2b66e5fc5ca96364f81
iuc
parents: 0
diff changeset
74 <output name="fasta_out" value="test_4.fna" ftype="fasta" />
21a7e1c0e072 planemo upload commit 19a431ffca44dd1fd61ba2b66e5fc5ca96364f81
iuc
parents: 0
diff changeset
75 </test>
0
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
76 </tests>
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
77
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
78 <help>
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
79
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
80 **barrnap**
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
81
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
82 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.
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
83 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.
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
84
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
85 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.
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
86
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
87 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.
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
88
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
89 .. _barrnap: https://github.com/tseemann/barrnap
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
90
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
91 **Inputs/Parameters**
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
92
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
93 *Fasta file*: The fasta file whose contents you want to search for ribosomal RNA's.
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
94
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
95 *Kingdom*: Select the Kingdom of the organism: Bacteria, Eukarote, Mitochondria or Archaea.
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
96
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
97 *Length cutoff*: Proportional length threshold to tag a possible rRNA as pseudo.
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
98
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
99 *Reject length threshold*: Proportional length threshold to reject prediction
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
100
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
101 *E-value*: Similarity cutoff e-value.
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
102
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
103 *Include Sequences in GFF*: This includes the original fasta sequence in the GFF file below the #FASTA tag
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
104
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
105 </help>
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
106 <citations>
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
107 <citation type="bibtex">@UNPUBLISHED{Seemann2013,
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
108 author = "Torsten Seemann",
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
109 title = "barrnap 0.8 : rapid ribosomal RNA prediction",
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
110 year = "2013",
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
111 note = "https://github.com/tseemann/barrnap"}
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
112 </citation>
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
113 </citations>
19ccd434db88 planemo upload commit 6d089b07b7a1d50b619e2ac6f33cd2bfe2a793c1
iuc
parents:
diff changeset
114 </tool>