annotate intersect.xml @ 0:f5d5eed73180 draft default tip

Imported from capsule None
author devteam
date Thu, 23 Jan 2014 12:31:34 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
1 <tool id="vcf_intersect" name="Intersect" version="1.0.0">
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
2 <description>Generate the intersection of two VCF files</description>
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
3 <command interpreter="python">
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
4 vcfPytools.py
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
5 intersect
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
6 --in=$input1
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
7 #if $format_type.format == "vcf"
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
8 --in=$input2
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
9 #elif $format_type.format == "bed"
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
10 --bed=$input2
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
11 #end if
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
12 #if $priority_file.value == "first_file"
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
13 --priority-file=$input1
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
14 #elif $priority_file.value == "second_file"
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
15 --priority-file=$input2
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
16 #end if
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
17 --out=$output1
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
18 </command>
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
19 <inputs>
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
20 <param name="input1" label="First VCF file" type="data" format="vcf" />
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
21 <conditional name="format_type">
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
22 <param name="format" type="select" label="intersect with file of format">
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
23 <option value="vcf">VCF</option>
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
24 <option value="bed">BED</option>
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
25 </param>
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
26 <when value="vcf">
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
27 <param name="input2" label="second VCF file" type="data" format="vcf"/>
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
28 </when>
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
29 <when value="bed">
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
30 <param name="input2" label="second BED file" type="data" format="bed"/>
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
31 </when>
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
32 </conditional>
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
33 <param name="priority_file" type="select" label="Priority file" help="If the priority file argument is set (this must be equal to one of the input vcf files), then the record written to the output will come from this file. If this argument is not set, the record with the highest quality is written out.">
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
34 <option value="none">None</option>
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
35 <option value="first_file">First file</option>
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
36 <option value="second_file">Second file</option>
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
37 </param>
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
38 </inputs>
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
39 <outputs>
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
40 <data format="vcf" name="output1" label="${tool.name} on ${on_string}" />
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
41 </outputs>
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
42 <tests>
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
43 <test>
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
44 <param name="input1" value="1.vcf" ftype="vcf" />
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
45 <param name="format" value="vcf" />
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
46 <param name="input2" value="2.vcf" ftype="vcf" />
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
47 <param name="priority_file" value="none" />
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
48 <output name="output" file="1_2_intersect_priority_0.vcf" lines_diff="2" ftype="vcf" />
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
49 </test>
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
50 <test>
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
51 <param name="input1" value="1.vcf" ftype="vcf" />
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
52 <param name="format" value="vcf" />
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
53 <param name="input2" value="2.vcf" ftype="vcf" />
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
54 <param name="priority_file" value="first_file" />
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
55 <output name="output" file="1_2_intersect_priority_1.vcf" lines_diff="2" ftype="vcf" />
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
56 </test>
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
57 <test>
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
58 <param name="input1" value="1.vcf" ftype="vcf" />
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
59 <param name="format" value="vcf" />
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
60 <param name="input2" value="2.vcf" ftype="vcf" />
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
61 <param name="priority_file" value="second_file" />
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
62 <output name="output" file="1_2_intersect_priority_2.vcf" lines_diff="2" ftype="vcf" />
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
63 </test>
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
64 </tests>
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
65 <help>
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
66
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
67 **What it does**
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
68
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
69 This tool uses vcfPytools_' intersect command to generate the intersection of two VCF files
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
70
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
71 .. _vcfPytools: https://github.com/AlistairNWard/vcfPytools
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
72
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
73 Two input files are required as input and the intersection of these two files is generated and sent to the output. These files must be sorted by genomic coordinate to function correctly, although the reference sequence order is no important.
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
74
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
75 The intersection can be calculated on two VCF files or a VCF and a BED file.
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
76
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
77 If the priority file argument is set (this must be equal to one of the input VCF files), then the record written to the output will come from this file. If this argument is not set, the record with the highest quality is written out.
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
78
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
79 </help>
f5d5eed73180 Imported from capsule None
devteam
parents:
diff changeset
80 </tool>