annotate snp_caller_caller.xml @ 0:80dae6d040a9 draft

Imported from capsule None
author wolma
date Sat, 13 Dec 2014 17:19:51 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
1 <tool id="variant_calling" name="Variant Calling">
80dae6d040a9 Imported from capsule None
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>
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
3 <requirements>
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
4 <requirement type="package" version="0.1.5">mimodd</requirement>
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
5 </requirements>
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
6 <version_command>mimodd version -q</version_command>
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
7 <command>
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
8 mimodd varcall
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
9
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
10 $ref_genome
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
11 #for $l in $list_input
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
12 ${l.inputfile}
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
13 #end for
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
14 --ofile $output_vcf
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
15 --depth $depth
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
16 $group_by_id
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
17 $no_md5_check
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
18 --verbose
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
19 --quiet
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
20 </command>
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
21
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
22 <inputs>
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
23 <param name="ref_genome" type="data" format="fasta" label="reference genome" />
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
24 <repeat name="list_input" title="Aligned reads input source" default="1" min="1">
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
25 <param name="inputfile" type="data" format="bam" label="input file" />
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
26 </repeat>
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
27 <param name="group_by_id" type="boolean" label="group reads based on read group id only" truevalue="-i" falsevalue="" checked="true" 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." />
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
28 <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)." />
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
29 <param name="depth" type="integer" value="250" label="maximum per-BAM depth (default: 250)" help="to avoid excessive use of memory"/>
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
30 </inputs>
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
31
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
32 <outputs>
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
33 <data name="output_vcf" format="bcf" label="Variant Calls from MiModd Variant Calling on ${on_string}"/>
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
34 </outputs>
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
35
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
36 <help>
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
37 .. class:: infomark
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
38
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
39 **What it does**
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
40
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
41 The tool transforms the read-centered information of its aligned reads input files into position-centered information.
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
42
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
43 **It produces a BCF file that serves as the basis for all further variant analyses with MiModD**.
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
44
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
45 **Notes:**
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
46
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
47 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
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
48 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.
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
49
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
50 This behavior has two benefits:
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
51
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
52 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
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
53
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
54 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).
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
55
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
56 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.
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
57
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
58 -----------
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
59
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
60 Internally, the tool uses samtools mpileup combined with bcftools to do all per-nucleotide calculations.
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
61
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
62 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.
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
63
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
64 </help>
80dae6d040a9 Imported from capsule None
wolma
parents:
diff changeset
65 </tool>