annotate vcfallelicprimitives.xml @ 0:239da20770dc

Imported from capsule None
author anton
date Wed, 11 Jun 2014 17:10:38 -0400
parents
children e66cbd28cdfa
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
239da20770dc Imported from capsule None
anton
parents:
diff changeset
1 <tool id="vcfallelicprimitives" name="VcfAllelicPrimitives:" version="0.0.1">
239da20770dc Imported from capsule None
anton
parents:
diff changeset
2 <requirements>
239da20770dc Imported from capsule None
anton
parents:
diff changeset
3 <requirement type="package" version="586c5ae5d57a38dae6b32ea831fb1f7cfa14c9bd">vcflib</requirement>
239da20770dc Imported from capsule None
anton
parents:
diff changeset
4 </requirements>
239da20770dc Imported from capsule None
anton
parents:
diff changeset
5 <description>Split alleleic primitives (gaps or mismatches) into multiple VCF lines</description>
239da20770dc Imported from capsule None
anton
parents:
diff changeset
6 <command>cat "${input}" | vcfallelicprimitives ${m_option} -t "${t_option}" > "${out_file1}"</command>
239da20770dc Imported from capsule None
anton
parents:
diff changeset
7 <inputs>
239da20770dc Imported from capsule None
anton
parents:
diff changeset
8 <param format="vcf" name="input" type="data" label="Select VCF dataset"/>
239da20770dc Imported from capsule None
anton
parents:
diff changeset
9 <param name="m_option" type="boolean" checked="true" truevalue="-m" falsevalue="" label="Retain MNPs as separate events" help="--use-mnps option"/>
239da20770dc Imported from capsule None
anton
parents:
diff changeset
10 <param name="t_option" size="20" type="text" value="Split primitives" label="Mark records which are split with this tag" help="--tag-parsed option"/>
239da20770dc Imported from capsule None
anton
parents:
diff changeset
11 </inputs>
239da20770dc Imported from capsule None
anton
parents:
diff changeset
12 <outputs>
239da20770dc Imported from capsule None
anton
parents:
diff changeset
13 <data format="vcf" name="out_file1" />
239da20770dc Imported from capsule None
anton
parents:
diff changeset
14 </outputs>
239da20770dc Imported from capsule None
anton
parents:
diff changeset
15 <tests>
239da20770dc Imported from capsule None
anton
parents:
diff changeset
16 <test>
239da20770dc Imported from capsule None
anton
parents:
diff changeset
17 <param name="m_option" value="true"/>
239da20770dc Imported from capsule None
anton
parents:
diff changeset
18 <param name="t_option" value="Split primitives"/>
239da20770dc Imported from capsule None
anton
parents:
diff changeset
19 <param name="input" value="vcflib.vcf"/>
239da20770dc Imported from capsule None
anton
parents:
diff changeset
20 <output name="out_file1" file="vcfallelicprimitives-test1.vcf"/>
239da20770dc Imported from capsule None
anton
parents:
diff changeset
21 </test>
239da20770dc Imported from capsule None
anton
parents:
diff changeset
22 </tests>
239da20770dc Imported from capsule None
anton
parents:
diff changeset
23 <help>
239da20770dc Imported from capsule None
anton
parents:
diff changeset
24
239da20770dc Imported from capsule None
anton
parents:
diff changeset
25 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. "Pure" MNPs are split into multiple SNPs unless the -m flag is provided. Genotypes are phased where complex alleles have been decomposed, provided genotypes in the input.
239da20770dc Imported from capsule None
anton
parents:
diff changeset
26
239da20770dc Imported from capsule None
anton
parents:
diff changeset
27 The options are::
239da20770dc Imported from capsule None
anton
parents:
diff changeset
28
239da20770dc Imported from capsule None
anton
parents:
diff changeset
29 --use-mnps (-m)
239da20770dc Imported from capsule None
anton
parents:
diff changeset
30 Retain MNPs as separate events
239da20770dc Imported from capsule None
anton
parents:
diff changeset
31
239da20770dc Imported from capsule None
anton
parents:
diff changeset
32 --tag-parsed (-t) FLAG
239da20770dc Imported from capsule None
anton
parents:
diff changeset
33 Tag records which are split apart of a complex allele
239da20770dc Imported from capsule None
anton
parents:
diff changeset
34 with this flag
239da20770dc Imported from capsule None
anton
parents:
diff changeset
35
239da20770dc Imported from capsule None
anton
parents:
diff changeset
36 ----
239da20770dc Imported from capsule None
anton
parents:
diff changeset
37
239da20770dc Imported from capsule None
anton
parents:
diff changeset
38 Vcfallelicprimitives is a part of VCFlib toolkit developed by Erik Garrison (https://github.com/ekg/vcflib).
239da20770dc Imported from capsule None
anton
parents:
diff changeset
39
239da20770dc Imported from capsule None
anton
parents:
diff changeset
40 </help>
239da20770dc Imported from capsule None
anton
parents:
diff changeset
41 </tool>