annotate snp_caller_caller.xml @ 13:f0b3871cb869 draft

Uploaded
author wolma
date Mon, 25 Apr 2016 17:27:25 -0400
parents 93db2f9bca12
children c46406466625
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9
93db2f9bca12 upgrade to v0.1.7.2
Wolfgang Maier wolfgang.maier@biologie.uni-freiburg.de
parents: 8
diff changeset
1 <tool id="variant_calling" name="Variant Calling" version="0.1.7.2">
0
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
2 <description>From a reference and aligned reads generate a BCF file with position-specific variant likelihoods and coverage information</description>
2
72d20758ba2c final upload
wolma
parents: 1
diff changeset
3 <macros>
72d20758ba2c final upload
wolma
parents: 1
diff changeset
4 <import>toolshed_macros.xml</import>
72d20758ba2c final upload
wolma
parents: 1
diff changeset
5 </macros>
72d20758ba2c final upload
wolma
parents: 1
diff changeset
6 <expand macro="requirements"/>
0
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
7 <version_command>mimodd version -q</version_command>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
8 <command>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
9 mimodd varcall
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
10
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
11 "$ref_genome"
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
12 #for $l in $list_input
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
13 "${l.inputfile}"
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
14 #end for
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
15 --ofile "$output_vcf"
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
16 --depth "$depth"
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
17 $group_by_id
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
18 $no_md5_check
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
19 --verbose
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
20 --quiet
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
21 </command>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
22
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
23 <inputs>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
24 <param name="ref_genome" type="data" format="fasta" label="reference genome" />
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
25 <repeat name="list_input" title="Aligned reads input source" default="1" min="1">
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
26 <param name="inputfile" type="data" format="bam" label="input file" />
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
27 </repeat>
4
ffee8534a5c4 upgrade to mimodd version 0.1.6
Wolfgang Maier
parents: 2
diff changeset
28 <param name="group_by_id" type="boolean" label="group reads based on read group id only" truevalue="-i" falsevalue="" checked="false" help="If selected, this option ensures that only the read group id (but not the sample name) is considered in grouping reads in the input file(s). If turned off, read groups with identical sample names are automatically pooled and analyzed together even if they come from different NGS runs." />
0
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
29 <param name="no_md5_check" type="boolean" label="turn off md5 sum verification" truevalue="-x" falsevalue="" checked="false" help="leave turned on to avoid accidental variant calling against a wrong reference genome version (see the tool help below)." />
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
30 <param name="depth" type="integer" value="250" label="maximum per-BAM depth (default: 250)" help="to avoid excessive use of memory"/>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
31 </inputs>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
32
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
33 <outputs>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
34 <data name="output_vcf" format="bcf" label="Variant Calls from MiModd Variant Calling on ${on_string}"/>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
35 </outputs>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
36
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
37 <help>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
38 .. class:: infomark
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
39
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
40 **What it does**
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
41
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
42 The tool transforms the read-centered information of its aligned reads input files into position-centered information.
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
43
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
44 **It produces a BCF file that serves as the basis for all further variant analyses with MiModD**.
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
45
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
46 **Notes:**
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
47
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
48 By default, the tool will check whether the input BAM file(s) provide(s) MD5 checksums for the reference genome sequences used during read alignment (the *SNAP Read Alignment* tool stores these in the BAM file header). If it finds MD5 sums for all sequences, it will compare them to the actual checksums of the sequences in the specified reference genome and
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
49 check that every sequence mentioned in any BAM input file has a counterpart with matching MD5 sum in the reference genome and abort with an error message if that is not the case. If it finds sequences with matching checksum, but different names in the reference genome, it will use the name from the reference genome file in its output.
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
50
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
51 This behavior has two benefits:
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
52
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
53 1) It protects from accidental variant calling against a wrong reference genome (i.e., a different one than that used during the alignment step), which would result in wrong calls. This is the primary reason why we recommend to leave the check activated
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
54
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
55 2) It provides an opportunity to change sequence names between aligned reads files and variant call files by providing a reference genome file with altered sequence names (but identical sequence data).
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
56
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
57 Since there may be rare cases where you *really* want to align against a reference genome with different checksums (e.g., you may have edited the reference sequence based on the alignment results), the check can be turned off, but only do this if you know exactly why.
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
58
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
59 -----------
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
60
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
61 Internally, the tool uses samtools mpileup combined with bcftools to do all per-nucleotide calculations.
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
62
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
63 It exposes just a single configuration parameter of these tools - the *maximum per-BAM depth*. Through this parameter, the maximum number of reads considered for variant calling at any site can be controlled. Its default value of 250 is taken from *samtools mpileup* and usually suitable. Consider, however, that this gives the maximum read number per input file, so if you have a large number of samples in one input file, it could become necessary to increase the value to get sufficient reads considered per sample.
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
64
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
65 </help>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
66 </tool>