annotate vt_normalize.xml @ 3:4ffcf0672e81 draft

Uploaded
author bgruening
date Thu, 14 Aug 2014 07:40:02 -0400
parents a5578ce1c0a1
children bb468ee178d8
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]
3
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
15
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
16 #if str( $intervals_file ) != 'None':
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
17 -I "${intervals_file}"
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
18 #end if
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
19
0
e4d445a95419 Uploaded
iuc
parents:
diff changeset
20 ##-i intervals []
3
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
21
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
22 #if $reference_source.reference_source_selector != "history":
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
23 -r "${reference_source.reference_genome.fields.path}"'
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
24 #else:
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
25 -r "${reference_source.reference_genome}"
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
26 #end if
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
27
0
e4d445a95419 Uploaded
iuc
parents:
diff changeset
28 "${ infile }"
e4d445a95419 Uploaded
iuc
parents:
diff changeset
29 ]]>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
30 </command>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
31 <expand macro="stdio" />
e4d445a95419 Uploaded
iuc
parents:
diff changeset
32 <inputs>
1
a5578ce1c0a1 Uploaded
iuc
parents: 0
diff changeset
33 <param name="infile" type="data" format="vcf" label="VCF file to be normalised" />
0
e4d445a95419 Uploaded
iuc
parents:
diff changeset
34
3
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
35
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
36 <conditional name="reference_source">
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
37 <param name="reference_source_selector" type="select" label="Choose the source for the reference list">
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
38 <option value="cached" selected="True">Locally cached</option>
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
39 <option value="history">History</option>
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
40 </param>
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
41 <when value="cached">
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
42 <param name="reference_genome" type="select" label="Using reference genome">
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
43 <options from_data_table="fasta_indexes">
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
44 <filter type="data_meta" ref="infile" key="dbkey" column="1" />
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
45 <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
46 </options>
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
47 </param>
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
48 </when>
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
49 <when value="history">
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
50 <param name="reference_genome" type="data" format="fasta" label="Using reference file" />
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
51 </when>
4ffcf0672e81 Uploaded
bgruening
parents: 1
diff changeset
52 </conditional>
0
e4d445a95419 Uploaded
iuc
parents:
diff changeset
53
e4d445a95419 Uploaded
iuc
parents:
diff changeset
54 <param name="intervals_file" type="data" format="bed" optional="True" label="File containing list of intervals" />
e4d445a95419 Uploaded
iuc
parents:
diff changeset
55 <param name="window" type="integer" value="10000" size="10" label="Window size for local sorting of variants"
e4d445a95419 Uploaded
iuc
parents:
diff changeset
56 help="(-w)">
e4d445a95419 Uploaded
iuc
parents:
diff changeset
57 <validator type="in_range" min="0"/>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
58 </param>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
59
e4d445a95419 Uploaded
iuc
parents:
diff changeset
60 </inputs>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
61 <outputs>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
62 <data name="outfile" format="vcf" label="${tool.name} on ${on_string}" />
e4d445a95419 Uploaded
iuc
parents:
diff changeset
63 </outputs>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
64 <tests>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
65 <test>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
66 </test>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
67 </tests>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
68 <help>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
69 **What it does**
e4d445a95419 Uploaded
iuc
parents:
diff changeset
70
e4d445a95419 Uploaded
iuc
parents:
diff changeset
71 Normalize variants in a VCF file. Normalized variants may have their positions changed; in such cases,
e4d445a95419 Uploaded
iuc
parents:
diff changeset
72 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
73
e4d445a95419 Uploaded
iuc
parents:
diff changeset
74 @CITATION@
e4d445a95419 Uploaded
iuc
parents:
diff changeset
75 </help>
e4d445a95419 Uploaded
iuc
parents:
diff changeset
76 <!--expand macro="citations"/-->
e4d445a95419 Uploaded
iuc
parents:
diff changeset
77 </tool>