comparison vcfrandomsample.xml @ 0:d9efe7842413 draft

Uploaded
author devteam
date Thu, 19 Mar 2015 14:44:16 -0400
parents
children c035d96c5cbe
comparison
equal deleted inserted replaced
-1:000000000000 0:d9efe7842413
1 <tool id="vcfrandomsample" name="VCFrandomSample:" version="0.0.3">
2 <description>Randomly sample sites from VCF dataset</description>
3 <macros>
4 <import>macros.xml</import>
5 </macros>
6 <expand macro="requirements"></expand>
7 <expand macro="stdio" />
8 <command>
9
10 #if $adv_options.adv_options_selector == True:
11 vcfrandomsample -s "${adv_options.scale_by}" -p ${random_seed} -r ${rate} "${vcf_input}" > "${out_file1}"
12 #else:
13 vcfrandomsample -p ${random_seed} -r ${rate} "${vcf_input}" > "${out_file1}"
14 #end if
15 </command>
16 <inputs>
17 <param format="vcf" name="vcf_input" type="data" label="Select random sites from"/>
18 <param name="rate" type="float" value="0.1" label="base sampling probability per locus" help="-r, --rate"/>
19 <param name="random_seed" type="integer" value="17823618326" label="use this random seed" help="-p, --random-seed; use this to make results reproducible" />
20 <conditional name="adv_options">
21 <param name="adv_options_selector" type="boolean" truevalue="use_adv_controls" label="Advanced controls" help="Allows you to specify options that are not listed above"/>
22 <when value="use_adv_controls">
23 <param name="scale_by" type="text" value="AF" label="scale sampling likelihood by this INFO field" help="-s, --scale-by; this only works for Float info fields such as AF" />
24 </when>
25 </conditional>
26 </inputs>
27 <outputs>
28 <data format="vcf" name="out_file1" />
29 </outputs>
30 <tests>
31 <test>
32 <param name="vcf_input" value="vcflib.vcf"/>
33 <param name="rate" value="0.2" />
34 <param name="random_seed" value="1" />
35 <param name="adv_options_selector" value="False" />
36 <output name="out_file1" file="vcfrandomsample-test1.vcf" lines_diff="2" />
37 </test>
38 </tests>
39 <help>
40
41 Randomly sample sites from an input VCF dataset. Scale the sampling probability by the field specified by --scale-by (see advanced controls). This may be
42 used to provide uniform sampling across allele frequencies, for instance (AF field in this case).
43
44 Options::
45
46 -r, --rate RATE base sampling probability per locus
47 -s, --scale-by KEY scale sampling likelihood by this Float info field
48 -p, --random-seed N use this random seed
49
50 ----
51
52 Vcfrandomsample @IS_PART_OF_VCFLIB@
53 </help>
54 <expand macro="citations" />
55 </tool>