annotate vcfrandomsample.xml @ 0:d9efe7842413 draft

Uploaded
author devteam
date Thu, 19 Mar 2015 14:44:16 -0400
parents
children c035d96c5cbe
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
d9efe7842413 Uploaded
devteam
parents:
diff changeset
1 <tool id="vcfrandomsample" name="VCFrandomSample:" version="0.0.3">
d9efe7842413 Uploaded
devteam
parents:
diff changeset
2 <description>Randomly sample sites from VCF dataset</description>
d9efe7842413 Uploaded
devteam
parents:
diff changeset
3 <macros>
d9efe7842413 Uploaded
devteam
parents:
diff changeset
4 <import>macros.xml</import>
d9efe7842413 Uploaded
devteam
parents:
diff changeset
5 </macros>
d9efe7842413 Uploaded
devteam
parents:
diff changeset
6 <expand macro="requirements"></expand>
d9efe7842413 Uploaded
devteam
parents:
diff changeset
7 <expand macro="stdio" />
d9efe7842413 Uploaded
devteam
parents:
diff changeset
8 <command>
d9efe7842413 Uploaded
devteam
parents:
diff changeset
9
d9efe7842413 Uploaded
devteam
parents:
diff changeset
10 #if $adv_options.adv_options_selector == True:
d9efe7842413 Uploaded
devteam
parents:
diff changeset
11 vcfrandomsample -s "${adv_options.scale_by}" -p ${random_seed} -r ${rate} "${vcf_input}" > "${out_file1}"
d9efe7842413 Uploaded
devteam
parents:
diff changeset
12 #else:
d9efe7842413 Uploaded
devteam
parents:
diff changeset
13 vcfrandomsample -p ${random_seed} -r ${rate} "${vcf_input}" > "${out_file1}"
d9efe7842413 Uploaded
devteam
parents:
diff changeset
14 #end if
d9efe7842413 Uploaded
devteam
parents:
diff changeset
15 </command>
d9efe7842413 Uploaded
devteam
parents:
diff changeset
16 <inputs>
d9efe7842413 Uploaded
devteam
parents:
diff changeset
17 <param format="vcf" name="vcf_input" type="data" label="Select random sites from"/>
d9efe7842413 Uploaded
devteam
parents:
diff changeset
18 <param name="rate" type="float" value="0.1" label="base sampling probability per locus" help="-r, --rate"/>
d9efe7842413 Uploaded
devteam
parents:
diff changeset
19 <param name="random_seed" type="integer" value="17823618326" label="use this random seed" help="-p, --random-seed; use this to make results reproducible" />
d9efe7842413 Uploaded
devteam
parents:
diff changeset
20 <conditional name="adv_options">
d9efe7842413 Uploaded
devteam
parents:
diff changeset
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"/>
d9efe7842413 Uploaded
devteam
parents:
diff changeset
22 <when value="use_adv_controls">
d9efe7842413 Uploaded
devteam
parents:
diff changeset
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" />
d9efe7842413 Uploaded
devteam
parents:
diff changeset
24 </when>
d9efe7842413 Uploaded
devteam
parents:
diff changeset
25 </conditional>
d9efe7842413 Uploaded
devteam
parents:
diff changeset
26 </inputs>
d9efe7842413 Uploaded
devteam
parents:
diff changeset
27 <outputs>
d9efe7842413 Uploaded
devteam
parents:
diff changeset
28 <data format="vcf" name="out_file1" />
d9efe7842413 Uploaded
devteam
parents:
diff changeset
29 </outputs>
d9efe7842413 Uploaded
devteam
parents:
diff changeset
30 <tests>
d9efe7842413 Uploaded
devteam
parents:
diff changeset
31 <test>
d9efe7842413 Uploaded
devteam
parents:
diff changeset
32 <param name="vcf_input" value="vcflib.vcf"/>
d9efe7842413 Uploaded
devteam
parents:
diff changeset
33 <param name="rate" value="0.2" />
d9efe7842413 Uploaded
devteam
parents:
diff changeset
34 <param name="random_seed" value="1" />
d9efe7842413 Uploaded
devteam
parents:
diff changeset
35 <param name="adv_options_selector" value="False" />
d9efe7842413 Uploaded
devteam
parents:
diff changeset
36 <output name="out_file1" file="vcfrandomsample-test1.vcf" lines_diff="2" />
d9efe7842413 Uploaded
devteam
parents:
diff changeset
37 </test>
d9efe7842413 Uploaded
devteam
parents:
diff changeset
38 </tests>
d9efe7842413 Uploaded
devteam
parents:
diff changeset
39 <help>
d9efe7842413 Uploaded
devteam
parents:
diff changeset
40
d9efe7842413 Uploaded
devteam
parents:
diff changeset
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
d9efe7842413 Uploaded
devteam
parents:
diff changeset
42 used to provide uniform sampling across allele frequencies, for instance (AF field in this case).
d9efe7842413 Uploaded
devteam
parents:
diff changeset
43
d9efe7842413 Uploaded
devteam
parents:
diff changeset
44 Options::
d9efe7842413 Uploaded
devteam
parents:
diff changeset
45
d9efe7842413 Uploaded
devteam
parents:
diff changeset
46 -r, --rate RATE base sampling probability per locus
d9efe7842413 Uploaded
devteam
parents:
diff changeset
47 -s, --scale-by KEY scale sampling likelihood by this Float info field
d9efe7842413 Uploaded
devteam
parents:
diff changeset
48 -p, --random-seed N use this random seed
d9efe7842413 Uploaded
devteam
parents:
diff changeset
49
d9efe7842413 Uploaded
devteam
parents:
diff changeset
50 ----
d9efe7842413 Uploaded
devteam
parents:
diff changeset
51
d9efe7842413 Uploaded
devteam
parents:
diff changeset
52 Vcfrandomsample @IS_PART_OF_VCFLIB@
d9efe7842413 Uploaded
devteam
parents:
diff changeset
53 </help>
d9efe7842413 Uploaded
devteam
parents:
diff changeset
54 <expand macro="citations" />
d9efe7842413 Uploaded
devteam
parents:
diff changeset
55 </tool>