annotate vcfbreakcreatemulti.xml @ 1:cf6b34535a33 draft default tip

Uploaded
author anton
date Tue, 10 Jun 2014 12:12:37 -0400
parents 448b21afcafa
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
cf6b34535a33 Uploaded
anton
parents: 0
diff changeset
1 <tool id="vcfbreakcreatemulti" name="VCFbreakCreateMulti:" version="0.0.1">
0
448b21afcafa Uploaded
anton
parents:
diff changeset
2 <requirements>
448b21afcafa Uploaded
anton
parents:
diff changeset
3 <requirement type="package" version="586c5ae5d57a38dae6b32ea831fb1f7cfa14c9bd">vcflib</requirement>
448b21afcafa Uploaded
anton
parents:
diff changeset
4 </requirements>
448b21afcafa Uploaded
anton
parents:
diff changeset
5 <description>Break multiple alleles into multiple records, or combine overallpoing alleles into a single record</description>
448b21afcafa Uploaded
anton
parents:
diff changeset
6 <command>
448b21afcafa Uploaded
anton
parents:
diff changeset
7
448b21afcafa Uploaded
anton
parents:
diff changeset
8 #if str($break_or_create) == "break":
448b21afcafa Uploaded
anton
parents:
diff changeset
9 vcfbreakmulti "${input1}" > "${out_file1}"
448b21afcafa Uploaded
anton
parents:
diff changeset
10 #elif str($break_or_create) == "create":
448b21afcafa Uploaded
anton
parents:
diff changeset
11 vcfcreatemulti "${input1}" > "${out_file1}"
448b21afcafa Uploaded
anton
parents:
diff changeset
12 #end if
448b21afcafa Uploaded
anton
parents:
diff changeset
13
448b21afcafa Uploaded
anton
parents:
diff changeset
14 </command>
448b21afcafa Uploaded
anton
parents:
diff changeset
15
448b21afcafa Uploaded
anton
parents:
diff changeset
16 <inputs>
1
cf6b34535a33 Uploaded
anton
parents: 0
diff changeset
17 <param format="vcf" name="input1" type="data" label="Select VCF dataset"/>
0
448b21afcafa Uploaded
anton
parents:
diff changeset
18 <param name="break_or_create" type="select" display="radio" label="Break or Create?">
448b21afcafa Uploaded
anton
parents:
diff changeset
19 <option value="break">Break</option>
448b21afcafa Uploaded
anton
parents:
diff changeset
20 <option value="create">Create</option>
448b21afcafa Uploaded
anton
parents:
diff changeset
21 </param>
448b21afcafa Uploaded
anton
parents:
diff changeset
22 </inputs>
448b21afcafa Uploaded
anton
parents:
diff changeset
23 <outputs>
448b21afcafa Uploaded
anton
parents:
diff changeset
24 <data format="vcf" name="out_file1" />
448b21afcafa Uploaded
anton
parents:
diff changeset
25 </outputs>
448b21afcafa Uploaded
anton
parents:
diff changeset
26 <tests>
448b21afcafa Uploaded
anton
parents:
diff changeset
27 <test>
448b21afcafa Uploaded
anton
parents:
diff changeset
28 <param name="break_or_create" value="break"/>
448b21afcafa Uploaded
anton
parents:
diff changeset
29 <param name="input1" value="vcflib.vcf"/>
448b21afcafa Uploaded
anton
parents:
diff changeset
30 <output name="out_file1" file="vcfbreakcreatemulti-test1.vcf"/>
448b21afcafa Uploaded
anton
parents:
diff changeset
31 </test>
448b21afcafa Uploaded
anton
parents:
diff changeset
32 <test>
448b21afcafa Uploaded
anton
parents:
diff changeset
33 <param name="break_or_create" value="create"/>
448b21afcafa Uploaded
anton
parents:
diff changeset
34 <param name="input1" value="vcfbreakcreatemulti-test2-input.vcf"/>
448b21afcafa Uploaded
anton
parents:
diff changeset
35 <output name="out_file1" file="vcfbreakcreatemulti-test2.vcf"/>
448b21afcafa Uploaded
anton
parents:
diff changeset
36 </test>
448b21afcafa Uploaded
anton
parents:
diff changeset
37 </tests>
448b21afcafa Uploaded
anton
parents:
diff changeset
38 <help>
448b21afcafa Uploaded
anton
parents:
diff changeset
39
1
cf6b34535a33 Uploaded
anton
parents: 0
diff changeset
40 This tool breaks or creates multiallelic VCF records based on user selection (**Break** or **Create**, respectively):
0
448b21afcafa Uploaded
anton
parents:
diff changeset
41
1
cf6b34535a33 Uploaded
anton
parents: 0
diff changeset
42 - **Break** = If multiple alleles are specified in a single record, break the record into multiple lines, preserving allele-specific INFO fields.
cf6b34535a33 Uploaded
anton
parents: 0
diff changeset
43 - **Create** = If overlapping alleles are represented across multiple records, merge them into a single record.
0
448b21afcafa Uploaded
anton
parents:
diff changeset
44
448b21afcafa Uploaded
anton
parents:
diff changeset
45 ----
448b21afcafa Uploaded
anton
parents:
diff changeset
46
448b21afcafa Uploaded
anton
parents:
diff changeset
47 This tools is based on vcfbreakmulti and vcfcreatemulti utilities from the VCFlib toolkit developed by Erik Garrison (https://github.com/ekg/vcflib).
448b21afcafa Uploaded
anton
parents:
diff changeset
48
448b21afcafa Uploaded
anton
parents:
diff changeset
49 </help>
448b21afcafa Uploaded
anton
parents:
diff changeset
50 </tool>