annotate barrnap.xml @ 2:fe48aa4ccd5e draft default tip

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