annotate varscan_copynumber.xml @ 0:a584f046e4a7 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:24 -0400
parents
children 8d8de66233ea
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
1 <tool id="varscan_copynumber" name="VarScan copynumber" version="@VERSION@.0">
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
2 <description>Determine relative tumor copy number from tumor-normal pileups</description>
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
3 <macros>
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
4 <import>macros.xml</import>
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
5 </macros>
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
6 <expand macro="requirements" />
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
7 <expand macro="stdio" />
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
8 <command><![CDATA[
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
9
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
10 varscan copynumber
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
11 '${normal_pileup}'
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
12 '${tumor_pileup}'
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
13 galaxy_out
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
14 --min-coverage ${min_coverage}
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
15 --min-base-qual ${min_base_qual}
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
16 --min-map-qual ${min_map_qual}
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
17
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
18 --min-segment-size ${min_segment_size}
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
19 --max-segment-size ${max_segment_size}
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
20 --p-value ${p_value}
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
21 --data-ratio ${data_ratio}
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
22
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
23 ]]></command>
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
24
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
25 <inputs>
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
26 <param name="normal_pileup" format="pileup" type="data" label="Samtools pileup dataset" help=""/>
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
27 <param name="tumor_pileup" format="pileup" type="data" label="Samtools pileup dataset" help=""/>
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
28
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
29 <param argument="--min-coverage" name="min_coverage" type="integer" value="20" min="1" max="200"
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
30 label="Minimum read depth" help="Minimum coverage threshold for copynumber segments"/>
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
31
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
32 <param argument="--min-base-qual" name="min_base_qual" type="integer" value="20" min="1" max="200"
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
33 label="Minimum base quality to count for coverage"/>
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
34 <param argument="--min-map-qual" name="min_map_qual" type="integer" value="20" min="1" max="200"
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
35 label="Minimum read mapping quality to count for coverage"/>
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
36
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
37 <param argument="--min-segment-size" name="min_segment_size" type="integer" value="10" min="1" max="200"
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
38 label="Minimum number of consecutive bases to report a segment" help="" />
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
39 <param argument="--max-segment-size" name="max_segment_size" type="integer" value="100" min="1" max="200"
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
40 label="Max size before a new segment is made" help="" />
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
41
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
42 <expand macro="p_value" label="P-value threshold for significant copynumber change-point" value="0.01" />
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
43
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
44 <param argument="--data-ratio" name="data_ratio" type="float" value="1.0" min="0.0" max="1.0"
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
45 label="The normal/tumor input data ratio for copynumber adjustment"/>
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
46
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
47 <param name="sample_names" type="text" value="" help="Separate sample names by comma; leave blank to use default sample names."/>
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
48
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
49 </inputs>
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
50 <outputs>
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
51 <data name="output" from_work_dir="galaxy_out.copynumber" format="interval"/>
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
52 </outputs>
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
53 <tests>
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
54 <test>
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
55 <param name="normal_pileup" value="N_Region_Chr1_CDKN2C.pileup.gz" />
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
56 <param name="tumor_pileup" value="T_Region_Chr1_CDKN2C.pileup.gz" />
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
57 <output name="output" file="varscan_copynumber_result1.interval" lines_diff="0" />
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
58 </test>
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
59 </tests>
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
60
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
61 <help>
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
62 **VarScan Overview**
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
63
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
64 VarScan_ performs variant detection for massively parallel sequencing data, such as exome, WGS, and transcriptome data.
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
65 It calls variants from a mpileup dataset and produces a VCF 4.1. Full documentation is available online_.
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
66
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
67 This tool estimates the relative tumor copy number from tumor-normal pileups.
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
68
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
69 .. _VarScan: http://dkoboldt.github.io/varscan/
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
70 .. _online: http://dkoboldt.github.io/varscan/using-varscan.html
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
71
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
72 **Input**
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
73
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
74 ::
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
75
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
76 mpileup file - The SAMtools mpileup files for the normal and tumor tissue
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
77
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
78
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
79 **Output**
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
80
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
81 VarScan produces a VCF 4.1 dataset as output.
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
82
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
83
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
84 </help>
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
85 <expand macro="citations" />
a584f046e4a7 planemo upload for repository https://github.com/galaxyproject/iuc/tree/master/tools/varscan commit 44c3f913e091bfdb94870ec3181390ad98711797
iuc
parents:
diff changeset
86 </tool>