annotate varscan/varscan_processSomatic.xml @ 0:848f3dc54593 draft

Uploaded
author geert-vandeweyer
date Fri, 07 Mar 2014 06:17:32 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
1 <tool id="varscan_processSomatic" name="ProcessSomatic" version="2.3.5">
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
2 <description>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
3 Extract HC calls from Somatic Caller
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
4 </description>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
5 <requirements>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
6 <requirement type="package" version="2.3.5">VarScan</requirement>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
7 </requirements>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
8 <command interpreter="perl">
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
9
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
10 varscan_processSomatic.pl
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
11 "COMMAND::java -jar \$JAVA_JAR_PATH/VarScan.v2.3.5.jar processSomatic"
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
12 "INPUT::$input"
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
13 "LOG::$log"
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
14
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
15 "OPTION::--min-tumor-freq $min_tumor_freq"
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
16 "OPTION::--max-normal-freq $max_normal_freq"
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
17 "OPTION::--p-value $p_value"
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
18 "OUTPUT::--loh $loh"
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
19 "OUTPUT::--loh_hc $loh_hc"
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
20 "OUTPUT::--germ $germ"
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
21 "OUTPUT::--germ_hc $germ_hc"
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
22 "OUTPUT::--som $som"
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
23 "OUTPUT::--som_hc $som_hc"
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
24 "OUTPUT::--som_hc_vcf $som_hc_vcf"
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
25 "OUTPUT::--germ_hc_vcf $germ_hc_vcf"
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
26 "OUTPUT::--loh_hc_vcf $loh_hc_vcf"
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
27
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
28 </command>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
29
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
30 <inputs>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
31
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
32 <param name="input" type="data" format="txt" label="Input File" help="VarScan Somatics output file in native format" />
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
33
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
34 <param name="min_tumor_freq" type="float" label="min-tumor-freq" help="Minimum variant allele frequency in tumor" optional="true" value="0.10"/>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
35 <param name="max_normal_freq" type="float" label="max-normal-freq" help="Maximum variant allele frequency in normal" optional="true" value="0.05"/>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
36 <param name="p_value" type="text" label="p-value" help="P-value for high-confidence calling" optional="true" value="0.07"/>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
37 <param name="outtype" type="select" label="Output Type:" default="1">
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
38 <option value="0">Native VarScan Tables</option>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
39 <option value="1">VCF format (only High Confidence)</option>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
40 <option value="2">Both</option>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
41 </param>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
42
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
43 </inputs>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
44 <outputs>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
45 <data type="data" format="txt" name="log" label="${tool.name} result on ${on_string} (log) " />
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
46 <data type="data" format="txt" name="loh" label="${tool.name} result on ${on_string} (loh) " >
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
47 <filter>outtype != "1"</filter>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
48 </data>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
49 <data type="data" format="txt" name="loh_hc" label="${tool.name} result on ${on_string} (loh_hc)">
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
50 <filter>outtype != "1"</filter>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
51 </data>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
52
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
53 <data type="data" format="txt" name="germ" label="${tool.name} result on ${on_string} (germline)" >
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
54 <filter>outtype != "1"</filter>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
55 </data>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
56
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
57 <data type="data" format="txt" name="germ_hc" label="${tool.name} result on ${on_string} (germline_hc)">
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
58 <filter>outtype != "1"</filter>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
59 </data>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
60
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
61 <data type="data" format="txt" name="som" label="${tool.name} result on ${on_string} (somatic)" >
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
62 <filter>outtype != "1"</filter>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
63 </data>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
64
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
65 <data type="data" format="txt" name="som_hc" label="${tool.name} result on ${on_string} (somatic_hc)" >
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
66 <filter>outtype != "1"</filter>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
67 </data>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
68
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
69 <data type="data" format="vcf" name="som_hc_vcf" label="${tool.name} result on ${on_string} (Somatic_HC.vcf)" >
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
70 <filter>outtype != "0"</filter>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
71 </data>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
72
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
73 <data type="data" format="vcf" name="loh_hc_vcf" label="${tool.name} result on ${on_string} (LOH_HC.vcf)" >
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
74 <filter>outtype != "0"</filter>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
75 </data>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
76
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
77 <data type="data" format="vcf" name="germ_hc_vcf" label="${tool.name} result on ${on_string} (Germline_HC.vcf)" >
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
78 <filter>outtype != "0"</filter>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
79 </data>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
80
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
81
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
82
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
83
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
84 </outputs>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
85
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
86 <help>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
87
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
88 .. class:: infomark
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
89
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
90 **What it does**
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
91
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
92 ::
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
93
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
94 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. It can be used to detect different types of variation:
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
95
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
96 Germline variants (SNPs an dindels) in individual samples or pools of samples.
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
97 Multi-sample variants (shared or private) in multi-sample datasets (with mpileup).
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
98 Somatic mutations, LOH events, and germline variants in tumor-normal pairs.
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
99 Somatic copy number alterations (CNAs) in tumor-normal exome data.
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
100
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
101
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
102 **Input**
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
103
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
104 ::
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
105
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
106 mpileup normal file - The SAMtools mpileup file for normal
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
107 mpileup tumor file - The SAMtools mpileup file for tumor
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
108
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
109
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
110 **Parameters**
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
111
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
112 ::
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
113
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
114 min-coverage
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
115 Minimum read depth at a position to make a call [8]
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
116
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
117 min-coverage-normal
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
118 Minimum coverage in normal to call somatic [8]
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
119
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
120 min-coverage-tumor
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
121 Minimum coverage in tumor to call somatic [6]
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
122
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
123 min-var-freq
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
124 Minimum variant frequency to call a heterozygote [0.10]
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
125
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
126 min-freq-for-hom
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
127 Minimum frequency to call homozygote [0.75]
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
128
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
129 normal-purity
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
130 Estimated purity (non-tumor content) of normal sample [1.00]
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
131
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
132 tumor-purity
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
133 Estimated purity (tumor content) of tumor sample [1.00]
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
134
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
135 p-value
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
136 Default p-value threshold for calling variants [0.99]
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
137
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
138 somatic-p-value
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
139 P-value threshold to call a somatic site [0.05]
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
140
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
141 strand-filter
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
142 If set to 1, removes variants with >90% strand bias
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
143
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
144 validation
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
145 If set to 1, outputs all compared positions even if non-variant
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
146
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
147 output-vcf
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
148 If set to 1, outputs in VCF format [Default]
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
149
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
150
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
151
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
152 </help>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
153 </tool>
848f3dc54593 Uploaded
geert-vandeweyer
parents:
diff changeset
154