annotate vcfrandomsample.xml @ 0:81b9a3179670

Imported from capsule None
author anton
date Wed, 11 Jun 2014 17:11:37 -0400
parents
children a67b14d368a4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
1 <tool id="vcfrandomsample" name="VCFrandomSample:" version="0.0.1">
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
2 <requirements>
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
3 <requirement type="package" version="586c5ae5d57a38dae6b32ea831fb1f7cfa14c9bd">vcflib</requirement>
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
4 </requirements>
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
5 <description>Randomly sample sites from VCF dataset</description>
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
6 <command>
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
7
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
8 #if $adv_options.adv_options_selector == True:
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
9 vcfrandomsample -s "${adv_options.scale_by}" -p ${random_seed} -r ${rate} "${vcf_input}" > "${out_file1}"
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
10 #else:
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
11 vcfrandomsample -p ${random_seed} -r ${rate} "${vcf_input}" > "${out_file1}"
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
12 #end if
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
13 </command>
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
14 <inputs>
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
15 <param format="vcf" name="vcf_input" type="data" label="Select random sites from"/>
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
16 <param name="rate" type="float" value="0.1" label="base sampling probability per locus" help="-r, --rate"/>
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
17 <param name="random_seed" type="integer" value="17823618326" label="use this random seed" help="-p, --random-seed; use this to make results reproducible" />
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
18 <conditional name="adv_options">
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
19 <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"/>
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
20 <when value="use_adv_controls">
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
21 <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" />
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
22 </when>
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
23 </conditional>
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
24 </inputs>
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
25 <outputs>
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
26 <data format="vcf" name="out_file1" />
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
27 </outputs>
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
28 <tests>
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
29 <test>
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
30 <param name="vcf_input" value="vcflib.vcf"/>
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
31 <param name="rate" value="0.2" />
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
32 <param name="random_seed" value="1" />
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
33 <param name="adv_options_selector" value="False" />
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
34 <output name="out_file1" file="vcfrandomsample-test1.vcf" lines_diff="2" />
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
35 </test>
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
36 </tests>
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
37 <help>
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
38
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
39 Randomly sample sites from an input VCF file. Scale the sampling probability by the field specified by --scale-by (see advanced controls). This may be
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
40 used to provide uniform sampling across allele frequencies, for instance (AF field in this case).
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
41
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
42 Options::
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
43
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
44 -r, --rate RATE base sampling probability per locus
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
45 -s, --scale-by KEY scale sampling likelihood by this Float info field
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
46 -p, --random-seed N use this random seed
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
47
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
48 ----
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
49
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
50 Vcfrandomsample is a part of VCFlib toolkit developed by Erik Garrison (https://github.com/ekg/vcflib).
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
51
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
52 </help>
81b9a3179670 Imported from capsule None
anton
parents:
diff changeset
53 </tool>