annotate varscan_mpileup.xml @ 0:1e667badbe87 draft

planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
author iuc
date Tue, 10 Jul 2018 13:36:03 -0400
parents
children d062703d6f13
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
1 <tool id="varscan_mpileup" name="VarScan mpileup" version="@VERSION@.0">
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
2 <description>for variant detection</description>
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
3 <macros>
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
4 <import>macros.xml</import>
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
5 </macros>
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
6 <expand macro="requirements" />
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
7 <expand macro="stdio" />
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
8 <command><![CDATA[
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
9 ## Set up samples list file.
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
10 #if $sample_names.strip() != '':
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
11 echo $sample_names | awk -F ',' '{ for (i = 1; i <= NF; i++) { print \$i; } }' > samples_list.txt &&
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
12 #end if
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
13
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
14 ## Set up command + input.
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
15 varscan ${cmd} '${input}'
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
16 --min-coverage ${min_coverage}
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
17 --min-reads2 ${min_reads2}
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
18 --min-avg-qual ${min_avg_qual}
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
19 --min-var-freq ${min_var_freq}
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
20 --min-freq-for-hom ${min_freq_for_hom}
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
21 --p-value ${p_value}
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
22
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
23 #if str($strand_filter) == 'yes':
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
24 --strand-filter 1
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
25 #end if
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
26
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
27 ## Report only variants in consensus.
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
28 #if str($cmd) == 'mpileup2cns':
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
29 --variants
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
30 #end if
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
31
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
32 ## Set up outputs.
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
33 --output-vcf 1 > '$output'
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
34
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
35 #if $sample_names.strip() != '':
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
36 --vcf-sample-list samples_list.txt
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
37 #end if
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
38
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
39 ]]></command>
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
40 <inputs>
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
41 <param name="input" format="pileup" type="data" label="Samtools pileup dataset" help=""/>
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
42
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
43 <param name="cmd" type="select" label="Analysis type">
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
44 <option value="mpileup2snp" selected="True">single nucleotide variation</option>
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
45 <option value="mpileup2indel">insertions and deletions</option>
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
46 <option value="mpileup2cns">consensus genotype</option>
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
47 </param>
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
48
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
49 <expand macro="min_coverage" />
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
50 <expand macro="min_reads2" />
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
51 <expand macro="min_avg_qual" />
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
52 <expand macro="min_var_freq" value="0.01" />
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
53 <expand macro="min_freq_for_hom" />
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
54 <expand macro="p_value" value="0.99" label="Default p-value threshold for calling variants"/>
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
55 <expand macro="strand_filter" />
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
56 <param name="sample_names" type="text" value="" help="Separate sample names by comma; leave blank to use default sample names."/>
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
57 </inputs>
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
58 <outputs>
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
59 <data name="output" format="vcf"/>
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
60 </outputs>
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
61 <tests>
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
62 <test>
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
63 <param name="input" value="test_in1.pileup" />
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
64 <param name="cmd" value="mpileup2cns" />
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
65 <param name="min_coverage" value="8" />
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
66 <param name="min_reads2" value="2" />
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
67 <param name="min_avg_qual" value="15" />
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
68 <param name="min_var_freq" value="0.01" />
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
69 <param name="min_freq_for_hom" value="0.75" />
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
70 <param name="p_value" value="0.99" />
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
71 <param name="strand_filter" value="no" />
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
72 <param name="sample_names" value="" />
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
73 <output name="output" file="varscan_mpileup_result1.vcf" lines_diff="0" />
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
74 </test>
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
75 </tests>
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
76
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
77 <help>
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
78 **VarScan Overview**
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
79
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
80 VarScan_ performs variant detection for massively parallel sequencing data, such as exome, WGS, and transcriptome data.
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
81 It calls variants from a mpileup dataset and produces a VCF 4.1. Full documentation is available online_.
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
82
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
83 This tool detects variants from pileups.
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
84
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
85 .. _VarScan: http://dkoboldt.github.io/varscan/
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
86 .. _online: http://dkoboldt.github.io/varscan/using-varscan.html
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
87
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
88 **Input**
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
89
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
90 ::
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
91
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
92 mpileup file - The SAMtools mpileup file
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
93
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
94
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
95 **Output**
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
96
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
97 VarScan produces a VCF 4.1 dataset as output.
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
98
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
99 </help>
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
100 <expand macro="citations" />
1e667badbe87 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
101 </tool>