annotate vcfselectsamples.xml @ 2:958b6484a7f1 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/vcflib/vcfselectsamples commit 19968c22ff96af3aef8afafd5224ac84013e0e44
author iuc
date Mon, 26 Mar 2018 18:00:19 -0400
parents 43cecdfe7107
children 2ba3b87f904f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
958b6484a7f1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/vcflib/vcfselectsamples commit 19968c22ff96af3aef8afafd5224ac84013e0e44
iuc
parents: 1
diff changeset
1 <tool id="vcfselectsamples" name="VCFselectsamples:" version="@WRAPPER_VERSION@+galaxy0">
1
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
2 <description>Select samples from a VCF dataset</description>
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
3 <macros>
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
4 <import>macros.xml</import>
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
5 </macros>
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
6 <expand macro="requirements"/>
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
7 <expand macro="stdio" />
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
8 <command>vcfkeepsamples "${input1}" ${ ' '.join( map( lambda x:'"%s"' % ( x ), str($vcf_samples ).split(",") ) ) } > "${out_file1}"</command>
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
9 <inputs>
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
10 <param format="vcf" name="input1" type="data" label="Select VCF dataset" />
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
11 <param name="vcf_samples" type="select" label="Check to keep samples; Uncheck to remove" display="checkboxes" multiple="true">
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
12 <options>
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
13 <filter type="data_meta" ref="input1" key="sample_names" />
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
14 </options>
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
15 </param>
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
16 </inputs>
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
17 <outputs>
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
18 <data format="vcf" name="out_file1" />
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
19 </outputs>
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
20 <tests>
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
21 <test>
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
22 <param name="vcf_samples" value="NA00001,NA00003"/>
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
23 <param name="input1" value="vcflib.vcf"/>
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
24 <output name="out_file1" file="vcfselectsamples-test1.vcf"/>
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
25 </test>
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
26 </tests>
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
27 <help>
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
28
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
29 Allows to keep or remove samples from a VCF file.
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
30
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
31 -----
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
32
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
33 .. class:: infomark
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
34
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
35
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
36 **Example**:
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
37
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
38 Selecting *NA00001* and *NA00003* from the following VCF line::
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
39
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
40 #CHROM POS ID REF ALT QUAL FILTER INFO FORMAT NA00001 NA00002 NA00003
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
41 20 1110696 rs6040355 A G,T 67 PASS NS=2;DP=10;AF=0.333,0.667;AA=T;DB GT:GQ:DP:HQ 1|2:21:6:23,27 2|1:2:0:18,2 2/2:35:4:.,.
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
42
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
43 will, obviously, remove *NA00002*::
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
44
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
45 #CHROM POS ID REF ALT QUAL FILTER INFO FORMAT NA00001 NA00003
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
46 20 1110696 rs6040355 A G,T 67 PASS NS=2;DP=10;AF=0.333,0.667;AA=T;DB GT:GQ:DP:HQ 1|2:21:6:23,27 2/2:35:4:.,.
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
47
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
48 ----
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
49
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
50 Vcfselectsamples is based on vcfkeepsamples/vcfremovesamples utilities from **VCFlib** toolkit developed by Erik Garrison (https://github.com/ekg/vcflib).
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
51 </help>
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
52 <expand macro="citations" />
43cecdfe7107 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfselectsamples commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 0
diff changeset
53 </tool>