annotate vt_normalize.xml @ 2:b1a42223e9f9 draft

Uploaded
author bgruening
date Thu, 14 Aug 2014 06:18:37 -0400
parents a5578ce1c0a1
children 4ffcf0672e81
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@
e4d445a95419 Uploaded
iuc
parents:
diff changeset
12 -o "${ outfile }"
e4d445a95419 Uploaded
iuc
parents:
diff changeset
13 ##-q do not print options and summary []
e4d445a95419 Uploaded
iuc
parents:
diff changeset
14 -w window size for local sorting of variants [10000]
e4d445a95419 Uploaded
iuc
parents:
diff changeset
15 -I $intervals_file
e4d445a95419 Uploaded
iuc
parents:
diff changeset
16 ##-i intervals []
e4d445a95419 Uploaded
iuc
parents:
diff changeset
17 -r $reference_genome
e4d445a95419 Uploaded
iuc
parents:
diff changeset
18 "${ infile }"
e4d445a95419 Uploaded
iuc
parents:
diff changeset
19 ]]>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
20 </command>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
21 <expand macro="stdio" />
e4d445a95419 Uploaded
iuc
parents:
diff changeset
22 <inputs>
1
a5578ce1c0a1 Uploaded
iuc
parents: 0
diff changeset
23 <param name="infile" type="data" format="vcf" label="VCF file to be normalised" />
0
e4d445a95419 Uploaded
iuc
parents:
diff changeset
24
e4d445a95419 Uploaded
iuc
parents:
diff changeset
25 <param name="reference_genome" type="select" label="Using reference genome">
e4d445a95419 Uploaded
iuc
parents:
diff changeset
26 <options from_data_table="fasta_indexes">
e4d445a95419 Uploaded
iuc
parents:
diff changeset
27 <filter type="data_meta" ref="infile" key="dbkey" column="1" />
e4d445a95419 Uploaded
iuc
parents:
diff changeset
28 <validator type="no_options" message="No reference genome is available for the build associated with the selected input dataset" />
e4d445a95419 Uploaded
iuc
parents:
diff changeset
29 </options>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
30 </param>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
31
e4d445a95419 Uploaded
iuc
parents:
diff changeset
32 <param name="intervals_file" type="data" format="bed" optional="True" label="File containing list of intervals" />
e4d445a95419 Uploaded
iuc
parents:
diff changeset
33 <param name="window" type="integer" value="10000" size="10" label="Window size for local sorting of variants"
e4d445a95419 Uploaded
iuc
parents:
diff changeset
34 help="(-w)">
e4d445a95419 Uploaded
iuc
parents:
diff changeset
35 <validator type="in_range" min="0"/>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
36 </param>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
37
e4d445a95419 Uploaded
iuc
parents:
diff changeset
38 </inputs>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
39 <outputs>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
40 <data name="outfile" format="vcf" label="${tool.name} on ${on_string}" />
e4d445a95419 Uploaded
iuc
parents:
diff changeset
41 </outputs>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
42 <tests>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
43 <test>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
44 </test>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
45 </tests>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
46 <help>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
47 **What it does**
e4d445a95419 Uploaded
iuc
parents:
diff changeset
48
e4d445a95419 Uploaded
iuc
parents:
diff changeset
49 Normalize variants in a VCF file. Normalized variants may have their positions changed; in such cases,
e4d445a95419 Uploaded
iuc
parents:
diff changeset
50 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
51
e4d445a95419 Uploaded
iuc
parents:
diff changeset
52 @CITATION@
e4d445a95419 Uploaded
iuc
parents:
diff changeset
53 </help>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
54 <!--expand macro="citations"/-->
e4d445a95419 Uploaded
iuc
parents:
diff changeset
55 </tool>