annotate dunovo.xml @ 10:9dc43bf7d1db draft

planemo upload for repository https://github.com/galaxyproject/dunovo commit b'230f018da2c0bc4eedc72e0f70eac0df1e85ebdb\n'-dirty

<?xml version="1.0"?>
<tool id="dunovo" name="Du Novo: Make consensus reads" version="2.15">
  <description>from duplex sequencing alignments</description>
  <requirements>
    <requirement type="package" version="2.15">dunovo</requirement>
    <!-- TODO: require Python 2.7 -->
  </requirements>
  <version_command>make-consensi.py --version</version_command>
  <command detect_errors="exit_code">
    make-consensi.py --galaxy $phone --processes \${GALAXY_SLOTS:-1}
    #if $out_format.type == 'fastq':
      --fastq-out $out_format.qual
    #end if
    --qual $qual_thres --qual-format $qual_format --min-reads $min_reads --cons-thres $cons_thres --min-cons-reads $min_cons_reads '$input' --dcs1 '$dcs1' --dcs2 '$dcs2'
    #if $keep_sscs:
      --sscs1 '$sscs1' --sscs2 '$sscs2'
    #end if
  </command>
  <inputs>
    <param name="input" type="data" format="tabular" label="Aligned input reads" />
    <param name="min_reads" type="integer" value="3" min="1" label="Minimum reads for a consensus" help="This many reads are necessary to form a single-strand consensus sequence. Families smaller than this will be skipped."/>
    <param name="cons_thres" type="float" value="0.5" min="0.5" max="1.0" label="Consensus % threshold" help="The consensus base must be present in more than this fraction of the reads, or &quot;N&quot; will be used instead."/>
    <param name="min_cons_reads" type="integer" value="0" min="0" label="Minimum number of reads for a consensus base." help="The consensus base must be present in more than this absolute number of reads, or &quot;N&quot; will be used instead."/>
    <conditional name="out_format">
      <param name="type" type="select" label="Output format">
        <option value="fasta" selected="true">FASTA</option>
        <option value="fastq">FASTQ</option>
      </param>
      <when value="fastq">
        <param name="qual" type="integer" value="40" min="0" max="93" label="Output PHRED score" help="There is currently no way to output a meaningful quality score for consensus bases. You'll have to specify an artificial one, which will be given to every base. A good value is 40, the maximum score normally output by sequencers. This means the bases won't be inadvertently filtered out by some downstream tool."/>
      </when>
    </conditional>
    <param name="qual_thres" type="integer" value="25" min="1" label="Minimum base quality" help="Bases with a PHRED score less than this will not be counted in the consensus making."/>
    <param name="qual_format" type="select" label="FASTQ format" help="Solexa should also work for Illumina 1.3+ and 1.5+, and Sanger should work for Illumina 1.8+">
      <option value="sanger" selected="true">Sanger (PHRED 0 = &quot;!&quot;)</option>
      <option value="solexa">Solexa (PHRED 0 = &quot;@&quot;)</option>
    </param>
    <param name="keep_sscs" type="boolean" truevalue="true" falsevalue="" label="Output single-strand consensus sequences as well" />
    <param name="phone" type="boolean" truevalue="--phone-home" falsevalue="" checked="False" label="Send usage data" help="Report helpful usage data to the developer, to better understand the use cases and performance of the tool. The only data which will be recorded is the name and version of the tool, the size of the input data, the number of processes used, the time and memory taken to process it, and the IP address of the machine running it. Also, if the tool fails, it will report the name of the exception thrown and the line of code it occurred in. The parameters and input/output dataset names are not sent. All the reporting and recording code is available at https://github.com/NickSto/ET."/>
  </inputs>
  <outputs>
    <data name="dcs1" label="$tool.name on $on_string (mate 1)">
      <change_format>
        <when input="out_format.type" value="fasta" format="fasta"/>
        <when input="out_format.type" value="fastq" format="fastq"/>
      </change_format>
    </data>
    <data name="dcs2" label="$tool.name on $on_string (mate 2)">
      <change_format>
        <when input="out_format.type" value="fasta" format="fasta"/>
        <when input="out_format.type" value="fastq" format="fastq"/>
      </change_format>
    </data>
    <data name="sscs1" label="$tool.name on $on_string (SSCS mate 1)">
      <filter>keep_sscs</filter>
      <change_format>
        <when input="out_format.type" value="fasta" format="fasta"/>
        <when input="out_format.type" value="fastq" format="fastq"/>
      </change_format>
    </data>
    <data name="sscs2" label="$tool.name on $on_string (SSCS mate 2)">
      <filter>keep_sscs</filter>
      <change_format>
        <when input="out_format.type" value="fasta" format="fasta"/>
        <when input="out_format.type" value="fastq" format="fastq"/>
      </change_format>
    </data>
  </outputs>
  <tests>
    <test>
      <param name="input" value="families.msa.tsv"/>
      <output name="dcs1" file="families.dcs_1.fa"/>
      <output name="dcs2" file="families.dcs_2.fa"/>
    </test>
  </tests>
  <help>

**What it does**

This is for processing duplex sequencing data. It creates single-strand and duplex consensus reads from aligned read families.

-----

**Input**

This expects the output format of the "Align families" tool.

-----

**Output**

This will output final, duplex consensus reads in two FASTA files (first and second reads in the pairs). Optionally, you can save the single-strand reads too, in a separate FASTA file.

  </help>
  <citations>
    <citation type="bibtex">@article{Stoler2016,
      author = {Stoler, Nicholas and Arbeithuber, Barbara and Guiblet, Wilfried and Makova, Kateryna D and Nekrutenko, Anton},
      doi = {10.1186/s13059-016-1039-4},
      issn = {1474-760X},
      journal = {Genome biology},
      number = {1},
      pages = {180},
      pmid = {27566673},
      publisher = {Genome Biology},
      title = {{Streamlined analysis of duplex sequencing data with Du Novo.}},
      url = {http://www.ncbi.nlm.nih.gov/pubmed/27566673},
      volume = {17},
      year = {2016}
    }</citation>
  </citations>
</tool>