annotate barrnap.xml @ 2:0b8af9f63afc draft default tip

Barrnap version 0.7
author simon-gladman
date Sat, 04 Jul 2015 10:33:34 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
1 <tool id="barrnap" name="barrnap" version="1.1.0">
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
2 <description>Locate bacterial ribosomal RNA's in a fasta file. (GFF output)</description>
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
3 <requirements>
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
4 <requirement type="package" version="0.7">barrnap</requirement>
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
5 </requirements>
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
6
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
7 <stdio>
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
8 <!-- Anything other than zero is an error -->
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
9 <exit_code range="1:" />
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
10 <exit_code range=":-1" />
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
11 <!-- In case the return code has not been set propery check stderr too -->
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
12 <regex match="Error:" />
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
13 <regex match="Exception:" />
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
14 </stdio>
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
15
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
16 <command><![CDATA[
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
17 barrnap
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
18 --quiet
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
19 --threads \${GALAXY_SLOTS:-1}
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
20 --reject $reject
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
21 --lencutoff $lencutoff
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
22 --evalue $evalue
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
23 #if $incseq
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
24 --incseq
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
25 #end if
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
26 --kingdom $kingdom
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
27 $fasta_file
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
28 > $gff
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
29 ]]>
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
30 </command>
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
31
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
32 <inputs>
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
33 <param name="fasta_file" type="data" format="fasta" label="Fasta file" help="Fasta file to look for rRNA's in" />
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
34 <param name="kingdom" type="select" label="Kingdom">
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
35 <option value="bac">Bacteria</option>
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
36 <option value="euk">Eukaryote</option>
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
37 <option value="mito">Mitochondria</option>
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
38 <option value="arc">Archaea</option>
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
39 </param>
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
40 <param name="reject" type="float" value="0.5" label="Reject length threshold" help="Proportional length threshold to reject prediction" />
0b8af9f63afc Barrnap version 0.7
simon-gladman
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" />
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
42 <param name="evalue" type="float" value="1e-06" label="e-value" help="Similarity e-value cutoff" />
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
43 <param name="incseq" type="boolean" label="Include Sequences in GFF" help="Include the fasta sequences in the GFF output file" />
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
44 </inputs>
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
45
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
46 <outputs>
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
47 <data name="gff" format="gff3" lavel="${tool.name} on ${on_string}: rRNA GFF"/>
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
48 </outputs>
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
49
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
50 <tests>
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
51 <test>
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
52 <param name="fasta_file" value="bacteria.fna" ftype="fasta" />
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
53 <param name="kingdom" value="bac" />
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
54 <output name="gff" value="bacteria.gff" ftype="gff3" />
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
55 </test>
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
56 </tests>
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
57
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
58 <help>
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
59
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
60 **barrnap**
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
61 ::
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
62 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.
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
63 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.
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
64
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
65 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.
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
66
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
67 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.
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
68
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
69 .. _barrnap: http://www.vicbioinformatics.com/software.barrnap.shtml
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
70
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
71 **Inputs/Parameters**
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
72 ::
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
73 **Fasta file**
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
74 The fasta file whose contents you want to search for ribosomal RNA's.
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
75 ::
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
76 **Kingdom**
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
77 Select the Kingdom of the organism: Bacteria, Eukarote, Mitochondria or Archaea.
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
78 ::
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
79 **Length cutoff**
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
80 Proportional length threshold to tag a possible rRNA as pseudo.
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
81 ::
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
82 **Reject length threshold**
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
83 Proportional length threshold to reject prediction
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
84 ::
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
85 **E-value**
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
86 Similarity cutoff e-value.
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
87 </help>
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
88 <citations>
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
89 <citation type="bibtex">@UNPUBLISHED{Seemann2013,
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
90 author = "Torsten Seemann",
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
91 title = "barrnap 0.7 : rapid ribosomal RNA prediction",
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
92 year = "2013",
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
93 note = "https://github.com/Victorian-Bioinformatics-Consortium/barrnap"}
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
94 </citation>
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
95 </citations>
0b8af9f63afc Barrnap version 0.7
simon-gladman
parents:
diff changeset
96 </tool>