view edena_ovl_wrapper.xml @ 1:cd6cc6d76708 draft

Simplify passing repeated params to Python script. Add more info to help sections.

<tool id="edena_ovl_wrapper" name="Edena (overlapping)" version="0.2.2">
  <description></description>
  <requirements>
    <requirement type="package" version="3.130110">edena</requirement>
  </requirements>
  <version_command>edena -v</version_command>
  <command interpreter="python">
    edena_ovl_wrapper.py
    \${EDENA_SITE_OPTIONS:---nThreads 2}
    #if $input_selection.input == "unpaired_file"
      #for $ui in $input_selection.unpaired_input
        --unpaired_input=${ui.unpaired_file}
      #end for
    #elif $input_selection.input == "dr_pairs"
      #for $dpi in $input_selection.dr_pairs_input
        --dr_pair_1=${dpi.dr_pair_1}
        --dr_pair_2=${dpi.dr_pair_2}
      #end for
    #elif $input_selection.input == "rd_pairs"
      #for $rpi in $input_selection.rd_pairs_input
        --rd_pair_1=${rpi.rd_pair_1}
        --rd_pair_2=${rpi.rd_pair_2}
      #end for
    #end if
    #if str($minOlap)
      --minOlap=$minOlap
    #end if
    #if str($readsTruncation)
      --readsTruncation=$readsTruncation
    #end if
    --output=$output
    --logfile=$logfile
  </command>

  <inputs>
    <conditional name="input_selection">
      <param name="input" type="select" label="Select input type">
        <option value="unpaired_file">Unpaired files</option>
        <option value="dr_pairs">Direct-reverse paired-end files</option>
        <option value="rd_pairs">Reverse-direct paired-end files</option>
      </param>

      <when value="unpaired_file">
        <repeat name="unpaired_input" title="Unpaired inputs (-r)" min="1">
          <param name="unpaired_file" type="data" format="fasta,fastq" label="Unpaired file" help="FASTA or FASTQ format" />
        </repeat>
      </when>

      <when value="dr_pairs">
        <repeat name="dr_pairs_input" title="DR paired-end inputs (-DRpairs, -paired)" min="1">
          <param name="dr_pair_1" type="data" format="fasta,fastq" label="DR paired-end file 1" help="FASTA or FASTQ format" />
          <param name="dr_pair_2" type="data" format="fasta,fastq" label="DR paired-end file 2" help="FASTA or FASTQ format" />
        </repeat>
      </when>

      <when value="rd_pairs">
        <repeat name="rd_pairs_input" title="RD paired-end inputs (-RDpairs, -matePairs)" min="1">
          <param name="rd_pair_1" type="data" format="fasta,fastq" label="RD paired-end file 1" help="FASTA or FASTQ format" />
          <param name="rd_pair_2" type="data" format="fasta,fastq" label="RD paired-end file 2" help="FASTA or FASTQ format" />
        </repeat>
      </when>
    </conditional>

    <param name="minOlap" type="integer" value="" optional="true" label="Minimum overlap size to compute (-M)" help="If not specified, this value is set to half of the reads length. When the sequencing coverage is sufficient, you can increase this value which will reduce the computational time. Edena will compute the overlaps whose sizes range from this value to the reads length." />

    <param name="readsTruncation" type="integer" value="" optional="true" label="3' end reads truncation (-t)" help="Use this option to truncate the 3’end of the reads such that the resulting length is the inserted value. You may consider reads truncation since it can significantly improve the assembly. Since Edena computes exact overlaps, only error free reads can take part to the assembly. Since errors are likely to occur at the 3’ ends, shortening the reads by some nucleotides may increase the number of errors-free reads in the dataset, and thus increase the assembly performance." />

  </inputs>

  <outputs>
    <data name="logfile" format="txt" label="${tool.name} on ${on_string}: log" />
    <data name="output" format="ovl" label="${tool.name} on ${on_string}: overlapping" />
  </outputs>

  <tests>

  </tests>
  <help>
**What it does**

Edena is an overlaps graph based short reads assembler and is suited to Illumina GA reads. An assembly with Edena is a two step process: overlapping and assembling.

In the overlapping step, the reads files are provided to the program which computes the transitively reduced overlaps graph. This structure is then stored together with the sequence reads in the overlapping file.

Edena can accept both unpaired and paired files, FASTQ and FASTA format. Note that for technical reasons, all reads are required to be of the same length. You can however provide the program with different files containing different reads length. In such case, Edena will trim the 3’ ends of the longer reads so that they fit the shorter length. It is however required that reads within each individual file are of the same length (as Illumina GA reads are). By default all overlaps with a minimum size corresponding to half of the reads length are computed. This is quite conservative. Provided enough coverage, this value can be increased (option -M) to reduce the memory requirements.

For reads longer than 100bp, you may consider the reads truncation option, which could help in discarding 3’ base calling errors.

**License and citation**

This Galaxy tool is Copyright © 2013 `CRS4 Srl.`_ and is released under the `MIT license`_.

.. _CRS4 Srl.: http://www.crs4.it/
.. _MIT license: http://opensource.org/licenses/MIT

If you use this tool in Galaxy, please cite |Cuccuru2013|_.

.. |Cuccuru2013| replace:: Cuccuru, G., Orsini, M., Pinna, A., Sbardellati, A., Soranzo, N., Travaglione, A., Uva, P., Zanetti, G., Fotia, G. (2013) Orione, a web-based framework for NGS analysis in microbiology. *Submitted*
.. _Cuccuru2013: http://orione.crs4.it/

This tool uses `Edena`_, which is licensed separately. Please cite |Hernandez2008|_.

.. _Edena: http://www.genomic.ch/edena.php
.. |Hernandez2008| replace:: Hernandez, D., *et al.* (2008) De novo bacterial genome sequencing: Millions of very short reads assembled on a desktop computer. *Genome Res.* 18(5), 802-809
.. _Hernandez2008: http://genome.cshlp.org/content/18/5/802
  </help>
</tool>