Mercurial > repos > iuc > ivar_consensus

annotate ivar_consensus.xml @ 19:6985fc65850a draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 249acacf7a562ab99130d311b7e322a80993ca44
author iuc
date Thu, 13 Mar 2025 09:00:10 +0000
parents 9d75c0aaf525
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
13
7ca451e578b9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 02d1d482bda9804c69d2d03c890151bc491e5c73
iuc
parents: 12
diff changeset
1 <tool id="ivar_consensus" name="ivar consensus" version="@TOOL_VERSION@+galaxy0" profile="@PROFILE@">
0
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
2 <description>Call consensus from aligned BAM file</description>
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
3 <macros>
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
4 <import>macros.xml</import>
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
5 </macros>
18
9d75c0aaf525 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit b548a504e88bd330f534be0dd018175c9341b1f1
iuc
parents: 14
diff changeset
6 <expand macro="xrefs"/>
11
0260131574e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a14db40361bcb2ee608bccd9222e1654aaea3324
iuc
parents: 0
diff changeset
7 <expand macro="requirements"/>
0260131574e9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit a14db40361bcb2ee608bccd9222e1654aaea3324
iuc
parents: 0
diff changeset
8 <expand macro="version_command"/>
0
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
9 <command detect_errors="exit_code"><![CDATA[
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
10 #import re
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
11 #set $clean_name = re.sub('[^\w\-]', '_', str($input_bam.element_identifier))
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
12 ln -s '$input_bam' sorted.bam &&
12
a2ce39845a74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit fc9887dd2a1468b58a5da12a91fe3fbcd226e981
iuc
parents: 11
diff changeset
13 samtools mpileup -A -a -d 0 -Q 0 sorted.bam | ivar consensus
0
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
14 -p consensus
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
15 -q $min_qual
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
16 -t $min_freq
13
7ca451e578b9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 02d1d482bda9804c69d2d03c890151bc491e5c73
iuc
parents: 12
diff changeset
17 -c $min_indel_freq
0
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
18 -m $min_depth
12
a2ce39845a74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit fc9887dd2a1468b58a5da12a91fe3fbcd226e981
iuc
parents: 11
diff changeset
19 $depth_action
0
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
20 &&
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
21 sed -i "s|consensus|$clean_name|" consensus.fa
12
a2ce39845a74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit fc9887dd2a1468b58a5da12a91fe3fbcd226e981
iuc
parents: 11
diff changeset
22 ]]></command>
0
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
23 <inputs>
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
24 <param name="input_bam" type="data" format="bam" label="Bam file" help="Aligned reads, to trim primers and quality"/>
12
a2ce39845a74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit fc9887dd2a1468b58a5da12a91fe3fbcd226e981
iuc
parents: 11
diff changeset
25 <param name="min_qual" argument="-q" type="integer" min="0" max="255" value="20" label="Minimum quality score threshold to count base"/>
0
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
26 <param name="min_freq" argument="-t" type="float" min="0" max="1" value="0.0" label="Minimum frequency threshold">
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
27 <help>
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
28 <![CDATA[
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
29 0 - Majority or most common base <br/>
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
30 0.2 - Bases that make up atleast 20% of the depth at a position <br/>
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
31 0.5 - Strict or bases that make up atleast 50% of the depth at a position <br/>
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
32 0.9 - Strict or bases that make up atleast 90% of the depth at a position <br/>
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
33 1 - Identical or bases that make up 100% of the depth at a position. Will have highest ambiguities
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
34 ]]>
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
35 </help>
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
36 </param>
13
7ca451e578b9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 02d1d482bda9804c69d2d03c890151bc491e5c73
iuc
parents: 12
diff changeset
37 <param name="min_indel_freq" argument="-c" type="float" min="0" max="1" value="0.8" label="Minimum indel frequency threshold" help="Same meaning as the &quot;Minimum frequency threshold&quot; above, but applied to indels."/>
14
1c67b9c203ce planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 3839802e0a790cb519cffdc2d8a6b92d73e4c9ef
iuc
parents: 13
diff changeset
38 <param name="min_depth" argument="-m" type="integer" min="1" value="10" label="Minimum depth to call consensus"/>
12
a2ce39845a74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit fc9887dd2a1468b58a5da12a91fe3fbcd226e981
iuc
parents: 11
diff changeset
39 <param name="depth_action" type="select" label="How to represent positions with coverage less than the minimum depth threshold">
a2ce39845a74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit fc9887dd2a1468b58a5da12a91fe3fbcd226e981
iuc
parents: 11
diff changeset
40 <option value="-k">Drop from output (-k)</option>
a2ce39845a74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit fc9887dd2a1468b58a5da12a91fe3fbcd226e981
iuc
parents: 11
diff changeset
41 <option value="-n N" selected="true">Represent as N (-n N)</option>
a2ce39845a74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit fc9887dd2a1468b58a5da12a91fe3fbcd226e981
iuc
parents: 11
diff changeset
42 <option value="-n -">Represent as - (-n -)</option>
a2ce39845a74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit fc9887dd2a1468b58a5da12a91fe3fbcd226e981
iuc
parents: 11
diff changeset
43 </param>
0
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
44 </inputs>
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
45 <outputs>
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
46 <data name="consensus" format="fasta" label="${tool.name} on ${on_string} Consensus" from_work_dir="consensus.fa"/>
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
47 </outputs>
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
48 <tests>
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
49 <test>
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
50 <param name="input_bam" value="covid19/PC00101P_sub.trimmed.sorted.bam" />
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
51 <output name="consensus" file="covid19/PC00101P_sub.fa" ftype="fasta" compare="contains" lines_diff="1"/>
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
52 </test>
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
53 </tests>
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
54 <help><![CDATA[
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
55 .. class:: infomark
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
56
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
57 To generate a consensus sequence iVar uses the output of samtools mpileup
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
58 command. The mpileup output must be piped into ivar consensus
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
59
12
a2ce39845a74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit fc9887dd2a1468b58a5da12a91fe3fbcd226e981
iuc
parents: 11
diff changeset
60 The command formed by this wrapper is :
0
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
61
12
a2ce39845a74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit fc9887dd2a1468b58a5da12a91fe3fbcd226e981
iuc
parents: 11
diff changeset
62 samtools mpileup -A -a -d 0 -Q 0 sorted.bam | ivar consensus [options]
0
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
63
13
7ca451e578b9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 02d1d482bda9804c69d2d03c890151bc491e5c73
iuc
parents: 12
diff changeset
64 There are five parameters that can be set:
12
a2ce39845a74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit fc9887dd2a1468b58a5da12a91fe3fbcd226e981
iuc
parents: 11
diff changeset
65
a2ce39845a74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit fc9887dd2a1468b58a5da12a91fe3fbcd226e981
iuc
parents: 11
diff changeset
66 - **Minimum quality**: the minimum quality of a base to be considered in calculations of variant frequencies at a given position
0
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
67
12
a2ce39845a74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit fc9887dd2a1468b58a5da12a91fe3fbcd226e981
iuc
parents: 11
diff changeset
68 - **Minimum frequency threshold**: the minimum frequency that the most likely base must surpass to be called as the consensus base at a position.
13
7ca451e578b9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 02d1d482bda9804c69d2d03c890151bc491e5c73
iuc
parents: 12
diff changeset
69
7ca451e578b9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 02d1d482bda9804c69d2d03c890151bc491e5c73
iuc
parents: 12
diff changeset
70 - **Minimum indel frequency threshold**: has the same meaning as the previous threshold, but gets applied to indels specifically. Setting this threshold higher than the threshold applied to SNVs helps reduce indel artefacts in the generated consensus.
7ca451e578b9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 02d1d482bda9804c69d2d03c890151bc491e5c73
iuc
parents: 12
diff changeset
71
12
a2ce39845a74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit fc9887dd2a1468b58a5da12a91fe3fbcd226e981
iuc
parents: 11
diff changeset
72 - **Minimum depth to call consensus**: the minimum required depth to call a consensus base
a2ce39845a74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit fc9887dd2a1468b58a5da12a91fe3fbcd226e981
iuc
parents: 11
diff changeset
73
a2ce39845a74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit fc9887dd2a1468b58a5da12a91fe3fbcd226e981
iuc
parents: 11
diff changeset
74 - **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:
0
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
75
12
a2ce39845a74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit fc9887dd2a1468b58a5da12a91fe3fbcd226e981
iuc
parents: 11
diff changeset
76 - Drop the position from the output entirely (-> the consensus sequence can become shorter than the reference used to produce the input BAM!)
a2ce39845a74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit fc9887dd2a1468b58a5da12a91fe3fbcd226e981
iuc
parents: 11
diff changeset
77 - Use an ``N``, or
a2ce39845a74 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit fc9887dd2a1468b58a5da12a91fe3fbcd226e981
iuc
parents: 11
diff changeset
78 - Use a ``-`` to represent the position
0
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
79 ]]> </help>
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
80 <expand macro="citations" />
4c22b03e981f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ivar/ commit 4b0b7fb6c79dcd437392a496a99301d124c9f1dd"
iuc
parents:
diff changeset
81 </tool>