annotate varscan_mpileup.xml @ 5:6e4920c4285f draft default tip

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