annotate ngsap-vc/varscan/varscan_somatic.xml @ 3:0d10255b5434 draft default tip

Uploaded
author scisjnu123
date Thu, 03 Oct 2019 10:42:15 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
1 <tool id="varscan_somatic" name="VarScan Somatic" version="2.3.5">
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
2 <description>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
3 somatic mutation caller for cancer genomics
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
4 </description>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
5 <requirements>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
6 <requirement type="package" version="2.3.5">VarScan</requirement>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
7 </requirements>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
8 <command interpreter="perl">
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
9 varscan_somatic.pl
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
10 "COMMAND::java -jar \$JAVA_JAR_PATH/VarScan.v2.3.5.jar somatic"
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
11 "NORMAL::$normal"
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
12 "TUMOR::$tumor"
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
13 "OUTPUT::$output"
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
14
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
15 "OPTION::--min-coverage $min_coverage"
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
16 "OPTION::--min-coverage-normal $min_coverage_normal"
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
17 "OPTION::--min-coverage-tumor $min_coverage_tumor"
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
18
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
19 "OPTION::--min-var-freq $min_var_freq"
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
20 "OPTION::--min-freq-for-hom $min_freq_for_hom"
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
21
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
22 "OPTION::--normal-purity $normal_purity"
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
23 "OPTION::--tumor-purity $tumor_purity"
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
24
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
25 "OPTION::--p-value $p_value"
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
26 "OPTION::--somatic-p-value $somatic_p_value"
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
27
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
28 "OPTION::--strand-filter $strand_filter"
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
29 "OPTION::--validation $validation"
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
30 "OPTION::--output-vcf 1"
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
31
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
32
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
33
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
34 </command>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
35
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
36 <inputs>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
37
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
38 <param name="normal" type="data" format="pileup" label="normal mpileup file" help="The SAMtools mpileup file for normal sample" />
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
39 <param name="tumor" type="data" format="pileup" label="tumor mpileup file" help="The SAMtools mpileup file for tumor sample" />
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
40
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
41 <param name="min_coverage" type="integer" label="min-coverage" help="" optional="true" value="8"/>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
42 <param name="min_coverage_normal" type="integer" label="min-coverage-normal" help="" optional="true" value="8"/>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
43 <param name="min_coverage_tumor" type="integer" label="min-coverage-tumor" help="" optional="true" value="6"/>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
44
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
45 <param name="min_var_freq" type="float" label="min-var-freq" help="" optional="true" value="0.10"/>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
46 <param name="min_freq_for_hom" type="float" label="min-freq-for-hom" help="" optional="true" value="0.75"/>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
47
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
48 <param name="normal_purity" type="float" label="normal-purity" help="" optional="true" value="1.00"/>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
49 <param name="tumor_purity" type="float" label="tumor-purity" help="" optional="true" value="1.00"/>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
50
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
51
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
52 <param name="p_value" type="text" label="p-value" help="" optional="true" value="0.99"/>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
53 <param name="somatic_p_value" type="text" label="somatic-p-value" help="" optional="true" value="0.05"/>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
54
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
55 <param name="strand_filter" type="integer" label="strand-filter" help="" optional="true" value="1"/>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
56 <param name="validation" type="integer" label="validation" help="" optional="true" value="0"/>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
57
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
58 </inputs>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
59 <outputs>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
60 <data type="data" format="vcf" name="output" label="${tool.name} result on ${on_string}"/>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
61 </outputs>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
62
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
63 <help>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
64
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
65 .. class:: infomark
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
66
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
67 **What it does**
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
68
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
69 ::
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
70
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
71 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:
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
72
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
73 Germline variants (SNPs an dindels) in individual samples or pools of samples.
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
74 Multi-sample variants (shared or private) in multi-sample datasets (with mpileup).
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
75 Somatic mutations, LOH events, and germline variants in tumor-normal pairs.
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
76 Somatic copy number alterations (CNAs) in tumor-normal exome data.
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
77
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
78
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
79 **Input**
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
80
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
81 ::
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
82
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
83 mpileup normal file - The SAMtools mpileup file for normal
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
84 mpileup tumor file - The SAMtools mpileup file for tumor
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
85
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
86
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
87 **Parameters**
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
88
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
89 ::
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
90
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
91 min-coverage
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
92 Minimum read depth at a position to make a call [8]
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
93
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
94 min-coverage-normal
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
95 Minimum coverage in normal to call somatic [8]
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
96
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
97 min-coverage-tumor
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
98 Minimum coverage in tumor to call somatic [6]
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
99
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
100 min-var-freq
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
101 Minimum variant frequency to call a heterozygote [0.10]
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
102
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
103 min-freq-for-hom
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
104 Minimum frequency to call homozygote [0.75]
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
105
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
106 normal-purity
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
107 Estimated purity (non-tumor content) of normal sample [1.00]
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
108
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
109 tumor-purity
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
110 Estimated purity (tumor content) of tumor sample [1.00]
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
111
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
112 p-value
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
113 Default p-value threshold for calling variants [0.99]
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
114
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
115 somatic-p-value
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
116 P-value threshold to call a somatic site [0.05]
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
117
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
118 strand-filter
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
119 If set to 1, removes variants with >90% strand bias
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
120
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
121 validation
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
122 If set to 1, outputs all compared positions even if non-variant
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
123
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
124 output-vcf
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
125 If set to 1, outputs in VCF format [Default]
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
126
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
127
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
128
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
129 </help>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
130 </tool>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
131