annotate varscan_mpileup2snp.xml @ 4:796653c6376b draft

Uploaded
author jason-ellul
date Wed, 01 Jun 2016 02:36:11 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
1 <?xml version="1.0" encoding="UTF-8"?>
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
2 <tool id="varscan_mpileup2snp" name="VarScan2 Call SNPs from a mpileup file">
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
3 <description>VarScan2 SNP/SNV detection; directly from a *.mpileup file.</description>
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
4 <requirements>
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
5 <requirement type="package" version="2.3.6">VarScan</requirement>
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
6 </requirements>
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
7 <command>
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
8 cat $mpileup_input | java
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
9 -Xmx64G
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
10 -jar \$JAVA_JAR_PATH/VarScan.v2.3.6.jar
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
11 mpileup2snp
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
12
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
13 #if $extended_parameters.parameters == "extended"
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
14 --min-coverage $varscan_min_coverage
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
15 --min-reads2 $varscan_min_reads2
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
16 --min-avg-qual $varscan_min_avg_qual
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
17 --min-var-freq $varscan_min_var_freq
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
18 --min-freq-for-hom $varscan_min_freq_for_hom
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
19 --p-value $varscan_p_value
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
20 $varscan_strand_filter
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
21 $varscan_variants
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
22 #end if
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
23
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
24 #if $varscan_output_vcf
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
25 --output-vcf 1
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
26 #end if
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
27
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
28 2> stderr.txt
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
29 > $snv_output ;
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
30 cat stderr.txt
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
31 </command>
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
32
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
33 <inputs>
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
34 <param format="pileup" name="mpileup_input" type="data" label="Alignment file" help="Mapped reads in mpileup format."/><!-- datatype "mpileup" does not exist.. it seems to be common to use pileup instead? -->
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
35
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
36 <conditional name="extended_parameters">
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
37 <param name="parameters" type="select" label="VarScan parameters" help="For more advanced VarScan settings.">
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
38 <option value="default">Default settings</option>
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
39 <option value="extended">Extended settings</option>
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
40 </param>
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
41 <when value="default">
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
42 </when>
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
43 <when value="extended">
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
44 <param type="integer" name="varscan_min_coverage" value="8" label="VarScan: Minimum read depth at a position to make a call [8]" />
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
45 <param type="integer" name="varscan_min_reads2" value="2" label="VarScan: PMinimum supporting reads at a position to call variants [2]" />
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
46 <param type="integer" name="varscan_min_avg_qual" value="15" label="VarScan: Minimum base quality at a position to count a read [15]" />
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
47 <param type="float" name="varscan_min_var_freq" value="0.01" label="VarScan: minimum fraction of gapped reads for candidates [0.002]" help="Alias: -F" />
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
48 <param type="float" name="varscan_min_freq_for_hom" value="0.75" label="VarScan: Minimum frequency to call homozygote [0.75]" />
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
49 <param type="float" name="varscan_p_value" value="0.99" label="VarScan: Default p-value threshold for calling variants [99e-02]" />
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
50 <param type="boolean" name="varscan_strand_filter" falsevalue=" --strand_filter 0" truevalue=" --strand_filter 1" checked="true" label="VarScan: Ignore variants with >90% support on one strand [1]" />
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
51 <param type="boolean" name="varscan_variants" falsevalue=" --variants 0" truevalue=" --variants 1" checked="false" label="VarScan: Report only variant (SNP/indel) positions [0]" />
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
52 </when>
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
53 </conditional>
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
54
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
55 <param type="boolean" name="varscan_output_vcf" falsevalue="0" truevalue="1" label="VarScan: If set to 1, outputs in VCF format" />
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
56 </inputs>
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
57
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
58 <outputs>
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
59 <data format="tabular" name="snv_output" label="${tool.name} on ${mpileup_input.hid}: ${mpileup_input.name}">
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
60 <change_format>
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
61 <when input="varscan_output_vcf" value="1" format="vcf" />
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
62 </change_format>
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
63 </data>
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
64 </outputs>
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
65
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
66 <tests>
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
67 <test>
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
68 <param name="mpileup_input" value="hg19_mutant.mpileup" dbkey="hg19" ftype="pileup" />
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
69 <param name="parameters" value="default" />
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
70 <param name="varscan_output_vcf" value="1" />
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
71
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
72
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
73 <output name="snv_output" file="hg19_mutant.vcf" />
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
74 </test>
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
75 </tests>
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
76
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
77 <help>
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
78 **VarScan 2.3.6**
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
79
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
80 VarScan is a platform-independent mutation caller for targeted, exome, and whole-genome resequencing data generated on Illumina, SOLiD, Life/PGM, Roche/454, and similar instruments. The newest version, VarScan 2, is written in Java, so it runs on most operating systems.
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
81 http://dx.doi.org/10.1101/gr.129684.111
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
82 http://www.ncbi.nlm.nih.gov/pubmed/19542151
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
83
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
84 *VarScan* requires mpileup formatted input files, which are generally derived from BAM files. Since mpileup files can become humongous, the interim step of storing it is bypassed. Thus, in this wrapper one or multiple BAM/SAM files go in, get processed into a mpileup file and get directly linked to VarScan.
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
85 The samtools package is not able to parallelize the mpileup generation which make it a very slow process.
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
86 Other people were aware of this and have written a version that can do parallelization:
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
87 https://github.com/mydatascience/parallel-mpileup
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
88
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
89 Consequently, when a BAM files gets processed by this wrapper, it's processed by *parallel-mpileup* before its send to VarScan.
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
90
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
91 .. _VarScan: http://varscan.sourceforge.net/
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
92
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
93 **Input formats**
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
94
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
95 VarScan2 accepts sequencing alignments in the same, either SAM or BAM format (http://samtools.sourceforge.net/). The alignment files have to be linked to a reference genome by galaxy. This is indicated under every history item with e.g.: *"database: hg19"* for a link to hg19, or *"database: ?"* if the link is missing.
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
96
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
97 **Installation**
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
98
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
99 Make sure your reference genomes are properly annotated in "tool-data/all_fasta.loc", and linked to the names of the reference used for alignment.
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
100
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
101 **License**
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
102
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
103 * VarScan2.3.6: Non-Profit Open Software License 3.0 (Non-Profit OSL 3.0)
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
104 * parallel-mpileup: MIT License (https://github.com/mydatascience/parallel-mpileup/blob/master/samtools-0.1.19/COPYING)
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
105
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
106
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
107 **Contact**
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
108
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
109 The tool wrapper has been written by Youri Hoogstrate from the Erasmus Medical Center (Rotterdam, Netherlands) on behalf of the Translational Research IT (TraIT) project:
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
110 http://www.ctmm.nl/en/programmas/infrastructuren/traitprojecttranslationeleresearch
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
111
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
112 More tools by the Translational Research IT (TraIT) project can be found in the following repository:
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
113 http://toolshed.dtls.nl/
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
114 </help>
796653c6376b Uploaded
jason-ellul
parents:
diff changeset
115 </tool>