annotate vcfallelicprimitives.xml @ 4:57a16b310fe8 draft default tip

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/vcflib/vcfallelicprimitives commit 36e9065027cc7bf721e9d203208477ee88906c57"
author iuc
date Thu, 23 Jan 2020 08:02:42 -0500
parents a8a4f94aa321
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
1 <?xml version="1.0" encoding="utf-8"?>
3
a8a4f94aa321 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/vcflib/vcfallelicprimitives commit c2af291b241e37e0a55adbc1fc72a9fa37d93582
iuc
parents: 2
diff changeset
2 <tool id="vcfallelicprimitives" name="VcfAllelicPrimitives:" version="@WRAPPER_VERSION@+galaxy0">
0
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
3 <description>Split alleleic primitives (gaps or mismatches) into multiple VCF lines</description>
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
4 <macros>
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
5 <import>macros.xml</import>
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
6 </macros>
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
7 <expand macro="requirements"></expand>
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
8 <expand macro="stdio" />
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
9 <command>
4
57a16b310fe8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/vcflib/vcfallelicprimitives commit 36e9065027cc7bf721e9d203208477ee88906c57"
iuc
parents: 3
diff changeset
10 cat '${input}' | vcfallelicprimitives
0
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
11 ${m_option}
4
57a16b310fe8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/vcflib/vcfallelicprimitives commit 36e9065027cc7bf721e9d203208477ee88906c57"
iuc
parents: 3
diff changeset
12 -t '${t_option}'
2
0a69cff7946e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfallelicprimitives commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 1
diff changeset
13 -L "${max_length}"
0
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
14 $keep_info
4
57a16b310fe8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/vcflib/vcfallelicprimitives commit 36e9065027cc7bf721e9d203208477ee88906c57"
iuc
parents: 3
diff changeset
15 $keep_geno > '${out_file1}'
0
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
16 </command>
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
17 <inputs>
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
18 <param format="vcf" name="input" type="data" label="Select VCF dataset"/>
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
19 <param name="m_option" type="boolean" checked="false" truevalue="--use-mnps" falsevalue="" label="Retain MNPs as separate events" help="--use-mnps option"/>
1
f49b23b41a12 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfallelicprimitives commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
20 <param name="t_option" type="text" value="Split primitives" label="Tag records which are split apart of a complex allele with this flag. " help="--tag-parsed option"/>
2
0a69cff7946e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/vcflib/vcfallelicprimitives commit 0b9b6512272b82637c2f1e831367e89aed77ae79
devteam
parents: 1
diff changeset
21 <param name="max_length" type="integer" value="200" label="Do not manipulate records in which either the ALT or REF is longer than (bp)" help="--max-length option"/>
0
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
22 <param name="keep_info" type="boolean" truevalue="--keep-info" falsevalue="" checked="False"
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
23 label="Maintain site and allele-level annotations when decomposing"
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
24 help="Note that in many cases, such as multisample VCFs, these won't be valid post-decomposition. For biallelic loci in single-sample VCFs, they should be usable with caution. (--keep-info)"/>
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
25 <param name="keep_geno" type="boolean" truevalue="--keep-geno" falsevalue="" checked="False"
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
26 label="Maintain genotype-level annotations when decomposing"
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
27 help="Similar caution should be used for this as for --keep-info. (--keep-geno)"/>
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
28 </inputs>
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
29 <outputs>
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
30 <data format="vcf" name="out_file1" label="${tool.name} on ${on_string}" />
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
31 </outputs>
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
32 <tests>
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
33 <test>
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
34 <param name="input" value="vcflib.vcf"/>
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
35 <output name="out_file1" file="vcfallelicprimitives-test1.vcf"/>
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
36 </test>
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
37 </tests>
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
38 <help>
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
39
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
40 If multiple alleleic primitives (gaps or mismatches) are specified in a single VCF record, this tools splits the record into multiple lines, but drops all INFO fields.
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
41 "Pure" MNPs are split into multiple SNPs unless the -m flag is provided.
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
42 Genotypes are phased where complex alleles have been decomposed, provided genotypes in the input.
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
43
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
44 The options are::
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
45
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
46 -m, --use-mnps Retain MNPs as separate events (default: false).
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
47 -t, --tag-parsed FLAG Tag records which are split apart of a complex allele with this flag.
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
48 -L, --max-length LEN Do not manipulate records in which either the ALT or
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
49 REF is longer than LEN (default: 200).
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
50 -k, --keep-info Maintain site and allele-level annotations when decomposing.
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
51 Note that in many cases, such as multisample VCFs, these won't
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
52 be valid post-decomposition. For biallelic loci in single-sample
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
53 VCFs, they should be usable with caution.
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
54 -g, --keep-geno Maintain genotype-level annotations when decomposing. Similar
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
55 caution should be used for this as for --keep-info.
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
56
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
57 ----
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
58
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
59 Vcfallelicprimitives @IS_PART_OF_VCFLIB@
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
60 </help>
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
61 <expand macro="citations" />
3f4fefbc52c8 Uploaded
devteam
parents:
diff changeset
62 </tool>