annotate ngsap-vc/varscan/varscan_mpileup.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_mpileup" name="VarScan mpileup" version="2.3.5">
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
2 <description>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
3 mutation caller for targeted, exome, and whole-genome resequencing
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
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
10 varscan_mpileup.pl
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
11 "COMMAND::java -jar \$JAVA_JAR_PATH/VarScan.v2.3.5.jar $exe_command"
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
12 "INPUT::$in_file"
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
13 "OUTPUT::$output"
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
14 "LOG::$log"
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
15 "OPTION::--min-coverage $min_coverage"
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
16 "OPTION::--min-reads2 $min_reads2"
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
17 "OPTION::--min-avg-qual $min_avg_qual"
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
18 "OPTION::--min-var-freq $min_var_freq"
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
19 "OPTION::--min-freq-for-hom $min_freq_for_hom"
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
20 "OPTION::--p-value $p_value"
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
21 "OPTION::--strand-filter $strand_filter"
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
22 "OPTION::--output-vcf 1"
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
23
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
24 #if ($vcf_sample_list):
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
25 "OPTION::--vcf-sample-list $vcf_sample_list"
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
26 #end if
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
27 "OPTION::--variants $variants"
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
28
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
29
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
30
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
31 </command>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
32
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
33 <inputs>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
34
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
35 <param name="exe_command" type="select" label="Command" help="" optional="false">
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
36 <option value="mpileup2snp" >mpileup2snp</option>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
37 <option value="mpileup2indel">mpileup2indel</option>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
38 <option value="mpileup2cns">mpileup2cns</option>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
39 </param>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
40 <param name="in_file" type="data" format="pileup" label="mpileup file" help="The SAMtools mpileup file" />
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_reads2" type="integer" label="min-reads2" help="" optional="true" value="2"/>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
43 <param name="min_avg_qual" type="integer" label="min-avg-qual" help="" optional="true" value="15"/>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
44 <param name="min_var_freq" type="float" label="min-var-freq" help="" optional="true" value="0.01"/>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
45 <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
46 <param name="p_value" type="text" label="p-value" help="" optional="true" value="0.99"/>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
47 <param name="strand_filter" type="integer" label="strand-filter" help="" optional="true" value="1"/>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
48 <param name="vcf_sample_list" type="data" label="vcf-sample-list" format="txt" help="" optional="true" />
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
49 <param name="variants" type="integer" label="variants" help="Set to 1 to report only variants" optional="true" value="1"/>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
50
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
51
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
52 </inputs>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
53 <outputs>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
54 <data type="data" format="vcf" name="output" label="${tool.name} result on ${on_string}"/>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
55 <data type="data" format="txt" name="log" label="${tool.name} result on ${on_string} (log) "/>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
56 </outputs>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
57
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
58 <help>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
59
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
60 .. class:: infomark
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
61
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
62 **What it does**
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
63
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
64 ::
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
65
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
66 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
67
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
68 Germline variants (SNPs an dindels) in individual samples or pools of samples.
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
69 Multi-sample variants (shared or private) in multi-sample datasets (with mpileup).
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
70 Somatic mutations, LOH events, and germline variants in tumor-normal pairs.
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
71 Somatic copy number alterations (CNAs) in tumor-normal exome data.
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
72
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
73
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
74 **Input**
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
75
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
76 ::
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
77
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
78 mpileup file - The SAMtools mpileup file
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
79
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
80
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
81 **Parameters**
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
82
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
83 ::
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
84
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
85 commands
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
86 mpileup2snp Identify SNPs from an mpileup file
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
87 mpileup2indel Identify indels an mpileup file
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
88 mpileup2cns Call consensus and variants from an mpileup file
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
89
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
90 min-coverage
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
91 Minimum read depth at a position to make a call [8]
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
92
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
93 min-reads2
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
94 Minimum supporting reads at a position to call variants [2]
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
95
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
96 min-avg-qual
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
97 Minimum base quality at a position to count a read [15]
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
98
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
99 min-var-freq
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
100 Minimum variant allele frequency threshold [0.01]
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
101
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
102 min-freq-for-hom
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
103 Minimum frequency to call homozygote [0.75]
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
104
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
105 p-value
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
106 Default p-value threshold for calling variants [99e-02]
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
107
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
108 strand-filter
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
109 Ignore variants with >90% support on one strand [1]
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
110
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
111 output-vcf
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
112 If set to 1, outputs in VCF format
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
113
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
114 vcf-sample-list
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
115 For VCF output, a list of sample names in order, one per line
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
116
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
117 variants
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
118 Report only variant (SNP/indel) positions [0]
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
119
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
120
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
121
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
122 </help>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
123 </tool>
0d10255b5434 Uploaded
scisjnu123
parents:
diff changeset
124