view ivar_consensus.xml @ 6:3bc2ef3d4a17 draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 847ec10cd36ea4f3cd4c257d5742f0fb401e364e"

<tool id="ivar_consensus" name="ivar consensus" version="@VERSION@+galaxy0">
    <description>Call consensus from aligned BAM file</description>
    <macros>
        <import>macros.xml</import>
    </macros>
    <expand macro="requirements" />
    <expand macro="version_command" />
    <command detect_errors="exit_code"><![CDATA[
        #import re
        #set $clean_name = re.sub('[^\w\-]', '_', str($input_bam.element_identifier))
        ln -s '$input_bam' sorted.bam &&
        samtools mpileup -A -d 0 -Q 0 sorted.bam | ivar consensus 
        -p consensus
        -q $min_qual
        -t $min_freq
        -m $min_depth
        $filter_depth
        #if $gap
        -n N
        #end if
        &&
        sed -i "s|consensus|$clean_name|" consensus.fa
    ]]>    </command>
    <inputs>
        <param name="input_bam" type="data" format="bam" label="Bam file" help="Aligned reads, to trim primers and quality"/>
        <param name="min_qual" argument="-q" type="integer" min="0" value="20" label="Minimum quality score threshold to count base"/>
        <param name="min_freq" argument="-t" type="float" min="0" max="1" value="0.0" label="Minimum frequency threshold">
            <help>
                <![CDATA[
           0 - Majority or most common base <br/>
         0.2 - Bases that make up atleast 20% of the depth at a position <br/>
         0.5 - Strict or bases that make up atleast 50% of the depth at a position <br/>
         0.9 - Strict or bases that make up atleast 90% of the depth at a position <br/>
           1 - Identical or bases that make up 100% of the depth at a position. Will have highest ambiguities 
        ]]>
            </help>
        </param>
        <param name="min_depth" argument="-m" type="integer" min="1" value="10" label="Minimum depth to call consensus"/>
        <param name="filter_depth" argument="-k" type="boolean" truevalue="-k" falsevalue="" checked="false" label="Exclude regions with smaller depth than the minimum threshold"/>
        <param name="gap" argument="-n" type="boolean" truevalue="true" falsevalue="false" checked="false" label="Use N instead of - for regions with less than minimum coverage"/>
    </inputs>
    <outputs>
        <data name="consensus" format="fasta" label="${tool.name} on ${on_string} Consensus" from_work_dir="consensus.fa"/>
    </outputs>
    <tests>
        <test>
            <param name="input_bam" value="covid19/PC00101P_sub.trimmed.sorted.bam" />
            <param name="gap" value="true" />
            <output name="consensus" file="covid19/PC00101P_sub.fa" ftype="fasta" compare="contains" lines_diff="1"/>
        </test>
    </tests>
    <help><![CDATA[
    .. class:: infomark

    To generate a consensus sequence iVar uses the output of samtools mpileup
    command. The mpileup output must be piped into ivar consensus
    
    The command for this wrapper is from https://github.com/andersen-lab/ivar/blob/master/pipeline_consensus/Snakefile :
    
    samtools mpileup -A -d 0 -Q 0 sorted.bam | ivar consensus [options]

    There are five parameters that can be set:

    - Minimum quality (Default: 20): the minimum quality of a base to be considered in calculations of variant frequencies at a given position

    - Minimum frequency threshold (Default: 0): the minimum frequency that a base must match to be called as the consensus base at a position.
    
    - Minimum depth to call a consensus (Default: 1): the minimum required depth to call a consensus

    - Filter depth is a flag to exclude nucleotides from regions with depth less than the minimum depth and a character to call in regions with coverage lower than the speicifed minimum depth(Default: '-'). If this flag is set then these regions are not included in the consensus sequence. If it is not set then by default, a '-' is called in these regions. 
    - You can also specfy which character you want to add to the consensus to cover regions with depth less than the minimum depth. This can be done using gap option. It takes of two values: '-' or 'N'.
    ]]>    </help>
    <expand macro="citations" />
</tool>