diff --git a/tools/ivar/ivar_consensus.xml b/tools/ivar/ivar_consensus.xml index c2f8329430e..b4a0707b94f 100644 --- a/tools/ivar/ivar_consensus.xml +++ b/tools/ivar/ivar_consensus.xml @@ -1,4 +1,4 @@ - + Call consensus from aligned BAM file macros.xml @@ -9,21 +9,20 @@ #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 + samtools mpileup -A -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 + $depth_action && sed -i "s|consensus|$clean_name|" consensus.fa - ]]> + ]]> - + + - - - + + + + + + @@ -45,7 +47,6 @@ - @@ -55,20 +56,23 @@ 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 : + The command formed by this wrapper is : - samtools mpileup -A -d 0 -Q 0 sorted.bam | ivar consensus [options] + samtools mpileup -A -a -d 0 -Q 0 sorted.bam | ivar consensus [options] - There are five parameters that can be set: + There are four 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 quality**: 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 frequency threshold**: the minimum frequency that the most likely base must surpass 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 + - **Minimum depth to call consensus**: the minimum required depth to call a consensus base + + - **How to represent positions with coverage less than the minimum depth threshold**: for positions for which the above minimum depth to call a consensus base is not reached, you can choose one of three different actions: - - 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'. + - Drop the position from the output entirely (-> the consensus sequence can become shorter than the reference used to produce the input BAM!) + - Use an ``N``, or + - Use a ``-`` to represent the position ]]>