annotate tools/vcf_tools/intersect.xml @ 0:9071e359b9a3

Uploaded
author xuebing
date Fri, 09 Mar 2012 19:37:19 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
1 <tool id="vcf_intersect" name="Intersect" version="1.0.0">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
2 <description>Generate the intersection of two VCF files</description>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
3 <command interpreter="python">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
4 vcfPytools.py
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
5 intersect
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
6 --in=$input1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
7 #if $format_type.format == "vcf"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
8 --in=$input2
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
9 #elif $format_type.format == "bed"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
10 --bed=$input2
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
11 #end if
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
12 #if $priority_file.value == "first_file"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
13 --priority-file=$input1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
14 #elif $priority_file.value == "second_file"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
15 --priority-file=$input2
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
16 #end if
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
17 --out=$output1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
18 </command>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
19 <inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
20 <param name="input1" label="First VCF file" type="data" format="vcf" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
21 <conditional name="format_type">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
22 <param name="format" type="select" label="intersect with file of format">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
23 <option value="vcf">VCF</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
24 <option value="bed">BED</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
25 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
26 <when value="vcf">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
27 <param name="input2" label="second VCF file" type="data" format="vcf"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
28 </when>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
29 <when value="bed">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
30 <param name="input2" label="second BED file" type="data" format="bed"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
31 </when>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
32 </conditional>
9071e359b9a3 Uploaded
xuebing
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.">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
34 <option value="none">None</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
35 <option value="first_file">First file</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
36 <option value="second_file">Second file</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
37 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
38 </inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
39 <outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
40 <data format="vcf" name="output1" label="${tool.name} on ${on_string}" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
41 </outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
42 <tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
43 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
44 <param name="input1" value="1.vcf" ftype="vcf" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
45 <param name="format" value="vcf" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
46 <param name="input2" value="2.vcf" ftype="vcf" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
47 <param name="priority_file" value="none" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
48 <output name="output" file="1_2_intersect_priority_0.vcf" lines_diff="2" ftype="vcf" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
49 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
50 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
51 <param name="input1" value="1.vcf" ftype="vcf" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
52 <param name="format" value="vcf" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
53 <param name="input2" value="2.vcf" ftype="vcf" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
54 <param name="priority_file" value="first_file" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
55 <output name="output" file="1_2_intersect_priority_1.vcf" lines_diff="2" ftype="vcf" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
56 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
57 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
58 <param name="input1" value="1.vcf" ftype="vcf" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
59 <param name="format" value="vcf" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
60 <param name="input2" value="2.vcf" ftype="vcf" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
61 <param name="priority_file" value="second_file" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
62 <output name="output" file="1_2_intersect_priority_2.vcf" lines_diff="2" ftype="vcf" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
63 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
64 </tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
65 <help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
66
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
67 **What it does**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
68
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
69 This tool uses vcfPytools_' intersect command to generate the intersection of two VCF files
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
70
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
71 .. _vcfPytools: https://github.com/AlistairNWard/vcfPytools
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
72
9071e359b9a3 Uploaded
xuebing
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.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
74
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
75 The intersection can be calculated on two VCF files or a VCF and a BED file.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
76
9071e359b9a3 Uploaded
xuebing
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.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
78
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
79 </help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
80 </tool>