annotate varscan/varscan_mpileup.xml @ 0:1cf258cb4fd7 draft

Initial upload of tool wrapper + supporting files.
author devteam
date Sat, 16 Nov 2013 18:45:02 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
1 <tool id="varscan" name="Varscan" version="0.1">
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
2 <description>for variant detection</description>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
3
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
4 <requirements>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
5 <requirement type="package" version="2.3.6">varscan</requirement>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
6 </requirements>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
7
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
8 <!--
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
9 The version command string is not yet a template that can be filled in, so version command is not yet possible.
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
10 <version_command>java -jar ${GALAXY_DATA_INDEX_DIR}/shared/jars/varscan/VarScan.jar 2>&amp;1 | head -n 1</version_command>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
11 -->
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
12
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
13 <command>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
14 ## Set up samples list file.
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
15 #if $sample_names.strip() != '':
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
16 echo $sample_names | awk -F ',' '{ for (i = 1; i &lt;= NF; i++) { print \$i; } }' > samples_list.txt;
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
17 #end if
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
18
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
19 ## Set up command + input.
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
20 java -jar \$JAVA_JAR_PATH/VarScan.v2.3.6.jar ${cmd} ${input}
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
21 --min-coverage ${min_coverage}
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
22 --min-reads2 ${min_supporting_reads}
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
23 --min-avg-qual ${min_avg_qual}
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
24 --min-var-freq ${min_var_freq}
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
25 --min-freq-for-hom ${min_freq_for_hom}
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
26 --p-value ${p_value}
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
27 #if str($strand_filter) == 'yes':
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
28 --strand-filter 1
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
29 #end if
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
30
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
31 ## Report only variants in consensus.
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
32 #if str($cmd) == 'mpileup2cns':
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
33 --variants
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
34 #end if
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
35
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
36 ## Set up outputs.
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
37 --output-vcf 1 > $output
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
38
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
39 #if $sample_names.strip() != '':
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
40 --vcf-sample-list samples_list.txt
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
41 #end if
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
42 </command>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
43
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
44 <inputs>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
45 <param format="pileup" name="input" type="data" label="Pileup dataset" help=""/>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
46
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
47 <param name="cmd" type="select" label="Analysis type">
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
48 <option value="mpileup2snp" selected="True">single nucleotide variation</option>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
49 <option value="mpileup2indel">insertions and deletions</option>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
50 <option value="mpileup2cns">consensus genotype</option>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
51 </param>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
52
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
53 <param name="min_coverage" type="integer" value="8" min="1" max="200" label="Minimum read depth" help="Minimum depth at a position to make a call"/>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
54 <param name="min_supporting_reads" type="integer" value="2" min="1" max="200" label="Minimum supporting reads" help="Minimum supporting reads at a position to make a call"/>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
55 <param name="min_avg_qual" type="integer" value="15" min="1" max="50" label="Minimum base quality at a position to count a read"/>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
56 <param name="min_var_freq" type="float" value="0.01" min="0" max="1" label="Minimum variant allele frequency threshold"/>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
57 <param name="min_freq_for_hom" type="float" value="0.75" min="0" max="1" label="Minimum frequency to call homozygote"/>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
58 <param name="p_value" type="float" value="0.99" min="0" max="1" label="p-value threshold for calling variants"/>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
59 <param name="strand_filter" type="select" label="Ignore variants with >90% support on one strand">
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
60 <option value="no" selected="True">no</option>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
61 <option value="yes">yes</option>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
62 </param>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
63 <param name="sample_names" type="text" value="" help="Separate sample names by comma; leave blank to use default sample names."/>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
64 </inputs>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
65
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
66 <stdio>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
67 <regex match="Exception" source="both" level="fatal" description="Tool exception"/>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
68 <regex match=".*" source="both" level="log" description="tool progress"/>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
69 </stdio>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
70
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
71 <outputs>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
72 <data name="output" format="vcf"/>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
73 </outputs>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
74
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
75 <trackster_conf>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
76 </trackster_conf>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
77
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
78 <tests>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
79 <test>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
80 <param name="input" value="test_in1.pileup" />
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
81 <param name="cmd" value="mpileup2cns" />
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
82 <param name="min_coverage" value="8" />
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
83 <param name="min_supporting_reads" value="2" />
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
84 <param name="min_avg_qual" value="15" />
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
85 <param name="min_var_freq" value="0.01" />
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
86 <param name="min_freq_for_hom" value="0.75" />
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
87 <param name="p_value" value="0.99" />
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
88 <param name="strand_filter" value="no" />
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
89 <param name="sample_names" value="" />
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
90 <output name="output" file="test_out1.vcf" lines_diff="0" />
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
91 </test>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
92 </tests>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
93
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
94 <help>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
95 **VarScan Overview**
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
96
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
97 VarScan_ performs variant detection for massively parallel sequencing data, such as exome, WGS, and transcriptome data. It calls variants from a mpileup dataset and produces a VCF 4.1 Full documentation is available online_.
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
98
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
99 Please cite: Koboldt, D., Zhang, Q., Larson, D., Shen, D., McLellan, M., Lin, L., Miller, C., Mardis, E., Ding, L., and Wilson, R. (2012). VarScan 2: Somatic mutation and copy number alteration discovery in cancer by exome sequencing Genome Research DOI: 10.1101/gr.129684.111
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
100
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
101 .. _VarScan: http://varscan.sourceforge.net/
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
102 .. _online: http://varscan.sourceforge.net/using-varscan.html
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
103
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
104 **Input**
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
105
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
106 ::
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
107
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
108 mpileup file - The SAMtools mpileup file
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
109
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
110
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
111 **Output**
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
112
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
113 VarScan produces a VCF 4.1 dataset as output.
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
114
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
115 **Parameters**
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
116
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
117 ::
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
118
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
119 commands
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
120 mpileup2snp Identify SNPs from an mpileup file
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
121 mpileup2indel Identify indels an mpileup file
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
122 mpileup2cns Call consensus and variants from an mpileup file
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
123
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
124 min-coverage
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
125 Minimum read depth at a position to make a call [8]
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
126
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
127 min-reads2
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
128 Minimum supporting reads at a position to call variants [2]
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
129
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
130 min-avg-qual
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
131 Minimum base quality at a position to count a read [15]
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
132
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
133 min-var-freq
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
134 Minimum variant allele frequency threshold [0.01]
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
135
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
136 min-freq-for-hom
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
137 Minimum frequency to call homozygote [0.75]
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
138
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
139 p-value
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
140 Default p-value threshold for calling variants [99e-02]
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
141
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
142 strand-filter
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
143 Ignore variants with >90% support on one strand [1]
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
144
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
145 output-vcf
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
146 If set to 1, outputs in VCF format
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
147
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
148 vcf-sample-list
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
149 For VCF output, a list of sample names in order, one per line
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
150
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
151 variants
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
152 Report only variant (SNP/indel) positions [0]
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
153
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
154 </help>
1cf258cb4fd7 Initial upload of tool wrapper + supporting files.
devteam
parents:
diff changeset
155 </tool>