annotate vcfrandomsample.xml @ 3:f7e6495859b9 draft default tip

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/vcflib/vcfrandomsample commit 36e9065027cc7bf721e9d203208477ee88906c57"
author iuc
date Thu, 23 Jan 2020 12:58:59 +0000
parents 939834d8de40
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
939834d8de40 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/vcflib/vcfrandomsample commit c2af291b241e37e0a55adbc1fc72a9fa37d93582
iuc
parents: 1
diff changeset
1 <tool id="vcfrandomsample" name="VCFrandomSample:" version="@WRAPPER_VERSION@+galaxy0">
1
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
2 <description>Randomly sample sites from VCF dataset</description>
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
3 <macros>
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
4 <import>macros.xml</import>
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
5 </macros>
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
6 <expand macro="requirements"/>
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
7 <expand macro="stdio" />
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
8 <command>
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
9 vcfrandomsample
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
10 #if $adv_options.adv_options_selector == "use_adv_controls":
3
f7e6495859b9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/vcflib/vcfrandomsample commit 36e9065027cc7bf721e9d203208477ee88906c57"
iuc
parents: 2
diff changeset
11 -s '${adv_options.scale_by}'
1
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
12 #end if
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
13 -p ${random_seed}
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
14 -r ${rate}
3
f7e6495859b9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/vcflib/vcfrandomsample commit 36e9065027cc7bf721e9d203208477ee88906c57"
iuc
parents: 2
diff changeset
15 '${vcf_input}' > '${out_file1}'
1
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
16 </command>
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
17 <inputs>
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
18 <param format="vcf" name="vcf_input" type="data" label="Select random sites from"/>
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
19 <param name="rate" type="float" value="0.1" label="base sampling probability per locus" help="-r, --rate"/>
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
20 <param name="random_seed" type="integer" value="17823618326" label="use this random seed"
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
21 help="-p, --random-seed; use this to make results reproducible" />
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
22 <conditional name="adv_options">
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
23 <param name="adv_options_selector" type="select" label="Advanced controls" help="Allows you to specify options that are not listed above">
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
24 <option value="no">Don't use advanced options</option>
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
25 <option value="use_adv_controls">Use advanced options</option>
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
26 </param>
2
939834d8de40 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/vcflib/vcfrandomsample commit c2af291b241e37e0a55adbc1fc72a9fa37d93582
iuc
parents: 1
diff changeset
27 <when value="no" />
1
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
28 <when value="use_adv_controls">
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
29 <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" />
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
30 </when>
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
31 </conditional>
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
32 </inputs>
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
33 <outputs>
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
34 <data format="vcf" name="out_file1" />
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
35 </outputs>
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
36 <tests>
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
37 <test>
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
38 <param name="vcf_input" value="vcflib.vcf"/>
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
39 <param name="rate" value="0.2" />
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
40 <param name="random_seed" value="1" />
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
41 <param name="adv_options_selector" value="no" />
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
42 <output name="out_file1" file="vcfrandomsample-test1.vcf" lines_diff="2" />
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
43 </test>
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
44 </tests>
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
45 <help>
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
46 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
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
47 used to provide uniform sampling across allele frequencies, for instance (AF field in this case).
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
48
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
49 ----
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
50
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
51 Vcfrandomsample @IS_PART_OF_VCFLIB@
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
52 </help>
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
53 <expand macro="citations" />
03030ecd1961 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfrandomsample commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
54 </tool>