annotate covacs_varscan2.xml @ 1:44e9fd8fd25a draft default tip

Uploaded
author elixir-it
date Thu, 15 Nov 2018 15:58:21 -0500
parents eaac11a49bd2
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
1 <tool id="covacs_varsca2" name="covacs_varscan2" version="2.4.2">
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
2 <description>varscan2 wrapper for covacs</description>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
3 <requirements>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
4 <requirement type="package" version="2.4.2">varscan</requirement>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
5 </requirements>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
6 <macros>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
7 <import>bed_macros.xml</import>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
8 </macros>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
9 <stdio>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
10 <regex match="Exception" source="both" level="fatal" description="Tool exception"/>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
11 <regex match=".*" source="both" level="log" description="tool progress"/>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
12 </stdio>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
13
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
14 <version_command><![CDATA[
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
15 varscan 2>&1 | head -n 1
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
16 ]]></version_command>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
17
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
18 <command><![CDATA[
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
19 ## Set up samples list file.
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
20 #if $sample_names.strip() != '':
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
21 echo $sample_names | awk -F ',' '{ for (i = 1; i <= NF; i++) { print \$i; } }' > samples_list.txt &&
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
22 #end if
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
23
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
24 ## Set up command + input.
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
25 varscan ${cmd} ${input}
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
26 --min-coverage ${min_coverage}
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
27 --min-reads2 ${min_supporting_reads}
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
28 --min-avg-qual ${min_avg_qual}
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
29 --min-var-freq ${min_var_freq}
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
30 --min-freq-for-hom ${min_freq_for_hom}
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
31 --p-value ${p_value}
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
32 #if str($strand_filter) == 'yes':
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
33 --strand-filter 1
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
34 #end if
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
35
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
36 ## Report only variants in consensus.
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
37 #if str($cmd) == 'mpileup2cns':
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
38 --variants
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
39 #end if
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
40
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
41 ## varscan bed limit added
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
42
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
43 #if $bed_source.bed_source_selector == "history" and $bed_source.bed_history
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
44 limit $bed_source.bed_history
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
45 #end if
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
46 #if $bed_source.bed_source_selector == "cached"
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
47 limit $bed_source.bed_cached.fields.path
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
48 #end if
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
49
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
50 ## Set up outputs.
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
51 --output-vcf 1 > $output
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
52
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
53 #if $sample_names.strip() != '':
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
54 --vcf-sample-list samples_list.txt
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
55 #end if
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
56
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
57 && perl $__tool_directory__/filter.varscan.pl $output $output_filtered
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
58 ]]></command>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
59
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
60 <inputs>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
61 <param format="pileup" name="input" type="data" label="Pileup dataset" help=""/>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
62 <param name="cmd" type="select" label="Analysis type">
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
63 <option value="mpileup2snp" selected="True">single nucleotide variation</option>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
64 <option value="mpileup2indel">insertions and deletions</option>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
65 <option value="mpileup2cns">consensus genotype</option>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
66 </param>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
67 <expand macro="bed_loc"/>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
68 <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"/>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
69 <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"/>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
70 <param name="min_avg_qual" type="integer" value="15" min="1" max="50" label="Minimum base quality at a position to count a read"/>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
71 <param name="min_var_freq" type="float" value="0.01" min="0" max="1" label="Minimum variant allele frequency threshold"/>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
72 <param name="min_freq_for_hom" type="float" value="0.75" min="0" max="1" label="Minimum frequency to call homozygote"/>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
73 <param name="p_value" type="float" value="0.99" min="0" max="1" label="p-value threshold for calling variants"/>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
74 <param name="strand_filter" type="select" label="Ignore variants with >90% support on one strand">
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
75 <option value="no" selected="True">no</option>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
76 <option value="yes">yes</option>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
77 </param>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
78 <param name="sample_names" type="text" value="" help="Separate sample names by comma; leave blank to use default sample names."/>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
79 </inputs>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
80
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
81 <outputs>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
82 <data name="output" format="vcf"/>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
83 <data format="vcf" name="output_filtered" label="varscan2 filtered on ${on_string}" />
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
84 </outputs>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
85 <tests>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
86 <test>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
87 <param name="input" value="test_in1.pileup" />
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
88 <param name="cmd" value="mpileup2cns" />
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
89 <param name="min_coverage" value="8" />
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
90 <param name="min_supporting_reads" value="2" />
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
91 <param name="min_avg_qual" value="15" />
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
92 <param name="min_var_freq" value="0.01" />
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
93 <param name="min_freq_for_hom" value="0.75" />
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
94 <param name="p_value" value="0.99" />
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
95 <param name="strand_filter" value="no" />
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
96 <param name="sample_names" value="" />
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
97 <output name="output" file="test_out1.vcf" lines_diff="0" />
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
98 </test>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
99 </tests>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
100
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
101 <help>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
102 **VarScan Overview**
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
103
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
104 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_.
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
105
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
106 .. _VarScan: http://dkoboldt.github.io/varscan/
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
107 .. _online: http://dkoboldt.github.io/varscan/using-varscan.html
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
108
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
109 **Input**
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
110
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
111 ::
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
112
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
113 mpileup file - The SAMtools mpileup file
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
114
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
115 **the wrapper gives 2 output**
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
116
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
117 -the normal output of varscan2
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
118
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
119 -the output filtered by the filter.varscan.pl script implemented in the covacs pipeline
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
120
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
121
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
122
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
123 **Parameters**
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
124
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
125 ::
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
126
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
127 analysis type
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
128 single nucleotide detection Identify SNPs from an mpileup file
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
129 insertions and deletion Identify indels an mpileup file
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
130 consensus genotype Call consensus and variants from an mpileup file
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
131
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
132 min-coverage
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
133 Minimum read depth at a position to make a call [8]
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
134
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
135 min-reads2
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
136 Minimum supporting reads at a position to call variants [2]
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
137
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
138 min-avg-qual
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
139 Minimum base quality at a position to count a read [15]
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
140
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
141 min-var-freq
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
142 Minimum variant allele frequency threshold [0.01]
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
143
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
144 min-freq-for-hom
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
145 Minimum frequency to call homozygote [0.75]
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
146
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
147 p-value
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
148 Default p-value threshold for calling variants [99e-02]
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
149
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
150 strand-filter
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
151 Ignore variants with >90% support on one strand [1]
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
152
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
153 output-vcf
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
154 If set to 1, outputs in VCF format
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
155
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
156 vcf-sample-list
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
157 For VCF output, a list of sample names in order, one per line
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
158
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
159 variants
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
160 Report only variant (SNP/indel) positions [0]
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
161 </help>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
162
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
163 <citations>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
164 <citation type="doi">10.1101/gr.129684.111</citation>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
165 <citation type="doi">10.1186/s12864-018-4508-1</citation>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
166 </citations>
eaac11a49bd2 Uploaded
elixir-it
parents:
diff changeset
167 </tool>