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

Barrnap version 0.7

<tool id="barrnap" name="barrnap" version="1.1.0">
    <description>Locate bacterial ribosomal RNA's in a fasta file. (GFF output)</description>
    <requirements>
        <requirement type="package" version="0.7">barrnap</requirement>
    </requirements>

    <stdio>
        <!-- Anything other than zero is an error -->
        <exit_code range="1:" />
        <exit_code range=":-1" />
        <!-- In case the return code has not been set propery check stderr too -->
        <regex match="Error:" />
        <regex match="Exception:" />
    </stdio>

    <command><![CDATA[
      barrnap
      --quiet
      --threads \${GALAXY_SLOTS:-1}
      --reject $reject
      --lencutoff $lencutoff
      --evalue $evalue
      #if $incseq
        --incseq
      #end if
      --kingdom $kingdom
      $fasta_file
      > $gff
      ]]>
    </command>

    <inputs>
      <param name="fasta_file" type="data" format="fasta" label="Fasta file" help="Fasta file to look for rRNA's in" />
      <param name="kingdom" type="select" label="Kingdom">
        <option value="bac">Bacteria</option>
        <option value="euk">Eukaryote</option>
        <option value="mito">Mitochondria</option>
        <option value="arc">Archaea</option>
      </param>
      <param name="reject" type="float" value="0.5" label="Reject length threshold" help="Proportional length threshold to reject prediction" />
      <param name="lencutoff" type="float" value="0.8" label="Length cutoff" help="Proportional length threshold to tag a find as pseudo" />
      <param name="evalue" type="float" value="1e-06" label="e-value" help="Similarity e-value cutoff" />
      <param name="incseq" type="boolean" label="Include Sequences in GFF" help="Include the fasta sequences in the GFF output file" />
    </inputs>

    <outputs>
      <data name="gff" format="gff3" lavel="${tool.name} on ${on_string}: rRNA GFF"/>
    </outputs>

    <tests>
      <test>
        <param name="fasta_file" value="bacteria.fna" ftype="fasta" />
        <param name="kingdom" value="bac" />
        <output name="gff" value="bacteria.gff" ftype="gff3" />
      </test>
    </tests>

<help>

**barrnap**
::
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.
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.

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.

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.

.. _barrnap: http://www.vicbioinformatics.com/software.barrnap.shtml

**Inputs/Parameters**
::
**Fasta file**
The fasta file whose contents you want to search for ribosomal RNA's.
::
**Kingdom**
Select the Kingdom of the organism: Bacteria, Eukarote, Mitochondria or Archaea.
::
**Length cutoff**
Proportional length threshold to tag a possible rRNA as pseudo.
::
**Reject length threshold**
Proportional length threshold to reject prediction
::
**E-value**
Similarity cutoff e-value.
</help>
<citations>
  <citation type="bibtex">@UNPUBLISHED{Seemann2013,
    author = "Torsten Seemann",
    title = "barrnap 0.7 : rapid ribosomal RNA prediction",
    year = "2013",
    note = "https://github.com/Victorian-Bioinformatics-Consortium/barrnap"}
  </citation>
</citations>
</tool>