annotate vt_normalize.xml @ 5:b425a93b4da6 draft

Uploaded
author bgruening
date Thu, 14 Aug 2014 10:44:32 -0400
parents bb468ee178d8
children d67bfd79bf6c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
e4d445a95419 Uploaded
iuc
parents:
diff changeset
1 <tool id="vt_@BINARY@" name="VT @BINARY@" version="@VERSION@.0">
e4d445a95419 Uploaded
iuc
parents:
diff changeset
2 <description>normalizes variants in a VCF file</description>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
3 <expand macro="requirements" />
e4d445a95419 Uploaded
iuc
parents:
diff changeset
4 <expand macro="version_command" />
e4d445a95419 Uploaded
iuc
parents:
diff changeset
5 <macros>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
6 <import>vt_macros.xml</import>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
7 <token name="@BINARY@">normalize</token>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
8 </macros>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
9 <command>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
10 <![CDATA[
e4d445a95419 Uploaded
iuc
parents:
diff changeset
11 vt @BINARY@
5
b425a93b4da6 Uploaded
bgruening
parents: 4
diff changeset
12 #if $output_format == 'bcf':
b425a93b4da6 Uploaded
bgruening
parents: 4
diff changeset
13 -o normalised.bcf
b425a93b4da6 Uploaded
bgruening
parents: 4
diff changeset
14 #else:
b425a93b4da6 Uploaded
bgruening
parents: 4
diff changeset
15 -o normalised.vcf
b425a93b4da6 Uploaded
bgruening
parents: 4
diff changeset
16 #end if
0
e4d445a95419 Uploaded
iuc
parents:
diff changeset
17 ##-q do not print options and summary []
4
bb468ee178d8 Uploaded
bgruening
parents: 3
diff changeset
18 -w $window
3
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
19
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
20 #if str( $intervals_file ) != 'None':
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
21 -I "${intervals_file}"
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
22 #end if
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
23
0
e4d445a95419 Uploaded
iuc
parents:
diff changeset
24 ##-i intervals []
3
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
25
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
26 #if $reference_source.reference_source_selector != "history":
4
bb468ee178d8 Uploaded
bgruening
parents: 3
diff changeset
27 -r "${reference_source.reference_genome.fields.path}"
3
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
28 #else:
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
29 -r "${reference_source.reference_genome}"
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
30 #end if
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
31
5
b425a93b4da6 Uploaded
bgruening
parents: 4
diff changeset
32 "${ infile }";
b425a93b4da6 Uploaded
bgruening
parents: 4
diff changeset
33
b425a93b4da6 Uploaded
bgruening
parents: 4
diff changeset
34 #if $output_format == 'bcf':
b425a93b4da6 Uploaded
bgruening
parents: 4
diff changeset
35 mv normalised.bcf "${ outfile }";
b425a93b4da6 Uploaded
bgruening
parents: 4
diff changeset
36 #else:
b425a93b4da6 Uploaded
bgruening
parents: 4
diff changeset
37 mv normalised.vcf "${ outfile }";
b425a93b4da6 Uploaded
bgruening
parents: 4
diff changeset
38 #end if
b425a93b4da6 Uploaded
bgruening
parents: 4
diff changeset
39
0
e4d445a95419 Uploaded
iuc
parents:
diff changeset
40 ]]>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
41 </command>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
42 <expand macro="stdio" />
e4d445a95419 Uploaded
iuc
parents:
diff changeset
43 <inputs>
1
a5578ce1c0a1 Uploaded
iuc
parents: 0
diff changeset
44 <param name="infile" type="data" format="vcf" label="VCF file to be normalised" />
0
e4d445a95419 Uploaded
iuc
parents:
diff changeset
45
3
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
46
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
47 <conditional name="reference_source">
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
48 <param name="reference_source_selector" type="select" label="Choose the source for the reference list">
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
49 <option value="cached" selected="True">Locally cached</option>
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
50 <option value="history">History</option>
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
51 </param>
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
52 <when value="cached">
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
53 <param name="reference_genome" type="select" label="Using reference genome">
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
54 <options from_data_table="fasta_indexes">
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
55 <filter type="data_meta" ref="infile" key="dbkey" column="1" />
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
56 <validator type="no_options" message="No reference genome is available for the build associated with the selected input dataset" />
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
57 </options>
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
58 </param>
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
59 </when>
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
60 <when value="history">
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
61 <param name="reference_genome" type="data" format="fasta" label="Using reference file" />
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
62 </when>
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
63 </conditional>
0
e4d445a95419 Uploaded
iuc
parents:
diff changeset
64
e4d445a95419 Uploaded
iuc
parents:
diff changeset
65 <param name="intervals_file" type="data" format="bed" optional="True" label="File containing list of intervals" />
e4d445a95419 Uploaded
iuc
parents:
diff changeset
66 <param name="window" type="integer" value="10000" size="10" label="Window size for local sorting of variants"
e4d445a95419 Uploaded
iuc
parents:
diff changeset
67 help="(-w)">
e4d445a95419 Uploaded
iuc
parents:
diff changeset
68 <validator type="in_range" min="0"/>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
69 </param>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
70
5
b425a93b4da6 Uploaded
bgruening
parents: 4
diff changeset
71 <param name="output_format" type="select" label="Choose the output format" help="">
b425a93b4da6 Uploaded
bgruening
parents: 4
diff changeset
72 <option value="bcf">BCF</option>
b425a93b4da6 Uploaded
bgruening
parents: 4
diff changeset
73 <option value="vcf" selected="true">VCF</option>
b425a93b4da6 Uploaded
bgruening
parents: 4
diff changeset
74 </param>
b425a93b4da6 Uploaded
bgruening
parents: 4
diff changeset
75
0
e4d445a95419 Uploaded
iuc
parents:
diff changeset
76 </inputs>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
77 <outputs>
5
b425a93b4da6 Uploaded
bgruening
parents: 4
diff changeset
78 <data name="outfile" format="vcf" label="${tool.name} on ${on_string}">
b425a93b4da6 Uploaded
bgruening
parents: 4
diff changeset
79 <change_format>
b425a93b4da6 Uploaded
bgruening
parents: 4
diff changeset
80 <when input="output_format" value="bcf" format="bcf" />
b425a93b4da6 Uploaded
bgruening
parents: 4
diff changeset
81 </change_format>
b425a93b4da6 Uploaded
bgruening
parents: 4
diff changeset
82 </data>
0
e4d445a95419 Uploaded
iuc
parents:
diff changeset
83 </outputs>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
84 <tests>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
85 <test>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
86 </test>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
87 </tests>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
88 <help>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
89 **What it does**
e4d445a95419 Uploaded
iuc
parents:
diff changeset
90
e4d445a95419 Uploaded
iuc
parents:
diff changeset
91 Normalize variants in a VCF file. Normalized variants may have their positions changed; in such cases,
e4d445a95419 Uploaded
iuc
parents:
diff changeset
92 the normalized variants are reordered and output in an ordered fashion. The local reordering takes place over a window of 10000 base pairs.
e4d445a95419 Uploaded
iuc
parents:
diff changeset
93
e4d445a95419 Uploaded
iuc
parents:
diff changeset
94 @CITATION@
e4d445a95419 Uploaded
iuc
parents:
diff changeset
95 </help>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
96 <!--expand macro="citations"/-->
e4d445a95419 Uploaded
iuc
parents:
diff changeset
97 </tool>