annotate table_annovar.xml @ 7:08b003ee9db7 draft

Uploaded
author devteam
date Wed, 22 Apr 2015 23:52:01 -0400
parents 091154194ce8
children d4e292ddda05
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
1 <tool id="table_annovar" name="ANNOVAR Annotate VCF" version="0.2">
0
75b252cf390e Uploaded
devteam
parents:
diff changeset
2 <description>with functional information using ANNOVAR</description>
75b252cf390e Uploaded
devteam
parents:
diff changeset
3
75b252cf390e Uploaded
devteam
parents:
diff changeset
4 <requirements>
75b252cf390e Uploaded
devteam
parents:
diff changeset
5 <requirement type="package">annovar</requirement>
5
7d2a81d29ca4 Uploaded
devteam
parents: 2
diff changeset
6 <requirement type="set_environment">SCRIPT_PATH</requirement>
0
75b252cf390e Uploaded
devteam
parents:
diff changeset
7 </requirements>
75b252cf390e Uploaded
devteam
parents:
diff changeset
8
75b252cf390e Uploaded
devteam
parents:
diff changeset
9 <command>
75b252cf390e Uploaded
devteam
parents:
diff changeset
10 ## Convert VCF to AV input format.
7
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
11 #if str($out_format) == "tabular":
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
12 convert2annovar.pl -format vcf4 -includeinfo ${input} > input.avinput ;
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
13 #set tab_anno_input = "input.avinput"
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
14 #else:
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
15 #set tab_anno_input = $input
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
16 #end if
0
75b252cf390e Uploaded
devteam
parents:
diff changeset
17
7
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
18 ## Variant annotation; make sure to include entry in indexes table for build database.
0
75b252cf390e Uploaded
devteam
parents:
diff changeset
19
75b252cf390e Uploaded
devteam
parents:
diff changeset
20 #set protocol = []
75b252cf390e Uploaded
devteam
parents:
diff changeset
21 #set operation = []
75b252cf390e Uploaded
devteam
parents:
diff changeset
22
75b252cf390e Uploaded
devteam
parents:
diff changeset
23 ## Add gene annotations.
75b252cf390e Uploaded
devteam
parents:
diff changeset
24 #if $gene_anns:
75b252cf390e Uploaded
devteam
parents:
diff changeset
25 #silent protocol.append( str( $gene_anns ) )
75b252cf390e Uploaded
devteam
parents:
diff changeset
26 #silent operation.append( ','.join( ['g' for t in range( str($gene_anns).count(',') + 1 )] ) )
75b252cf390e Uploaded
devteam
parents:
diff changeset
27 #end if
75b252cf390e Uploaded
devteam
parents:
diff changeset
28
75b252cf390e Uploaded
devteam
parents:
diff changeset
29 ## Add regions.
75b252cf390e Uploaded
devteam
parents:
diff changeset
30 #if $regions:
75b252cf390e Uploaded
devteam
parents:
diff changeset
31 #silent protocol.append( str( $regions ) )
75b252cf390e Uploaded
devteam
parents:
diff changeset
32 #silent operation.append( ','.join( ['r' for t in range( str($regions).count(',') + 1 )] ) )
75b252cf390e Uploaded
devteam
parents:
diff changeset
33 #end if
75b252cf390e Uploaded
devteam
parents:
diff changeset
34
75b252cf390e Uploaded
devteam
parents:
diff changeset
35 ## Add filters.
75b252cf390e Uploaded
devteam
parents:
diff changeset
36 #if $filters:
75b252cf390e Uploaded
devteam
parents:
diff changeset
37 #silent protocol.append( str( $filters ) )
75b252cf390e Uploaded
devteam
parents:
diff changeset
38 #silent operation.append( ','.join( ['f' for t in range( str($filters).count(',') + 1 )] ) )
75b252cf390e Uploaded
devteam
parents:
diff changeset
39 #end if
75b252cf390e Uploaded
devteam
parents:
diff changeset
40
75b252cf390e Uploaded
devteam
parents:
diff changeset
41 #set protocol = ','.join( $protocol )
7
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
42 #set operation = ','.join( $operation )
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
43
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
44 ## Annotate variants.
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
45 table_annovar.pl ${tab_anno_input} ${__get_data_table_entry__('annovar_indexes', 'dbkey', $input.dbkey, 'path')} -protocol ${protocol} -operation ${operation} -nastring '.' -buildver ${input.dbkey} --outfile output
0
75b252cf390e Uploaded
devteam
parents:
diff changeset
46
7
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
47 ## Add option to consume/produce VCF.
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
48 #if str($out_format) == "vcf":
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
49 --vcfinput
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
50 #end if
0
75b252cf390e Uploaded
devteam
parents:
diff changeset
51
7
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
52 ## Post-processing: process annotated table to remove "NA" strings from numerical columns if
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
53 ## tabular. Copy to output.
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
54 #if str($out_format) == "tabular":
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
55 ; cat output.${input.dbkey}_multianno.txt | python \${SCRIPT_PATH}/replace_NA.py > ${output}
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
56 #else:
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
57 ; cp output.${input.dbkey}_multianno.vcf ${output}
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
58 #end if
0
75b252cf390e Uploaded
devteam
parents:
diff changeset
59 </command>
75b252cf390e Uploaded
devteam
parents:
diff changeset
60
75b252cf390e Uploaded
devteam
parents:
diff changeset
61 <inputs>
75b252cf390e Uploaded
devteam
parents:
diff changeset
62 <param name="input" type="data" format="vcf" metadata_name="dbkey" label="Variants" help="">
75b252cf390e Uploaded
devteam
parents:
diff changeset
63 <validator type="unspecified_build" />
75b252cf390e Uploaded
devteam
parents:
diff changeset
64 </param>
75b252cf390e Uploaded
devteam
parents:
diff changeset
65
75b252cf390e Uploaded
devteam
parents:
diff changeset
66 <param name="gene_anns" type="select" multiple="True" optional="True" label="Gene Annotations" help="" >
75b252cf390e Uploaded
devteam
parents:
diff changeset
67 <options from_data_table="annovar_indexes">
75b252cf390e Uploaded
devteam
parents:
diff changeset
68 <filter type="data_meta" key="dbkey" ref="input" column="1"/>
75b252cf390e Uploaded
devteam
parents:
diff changeset
69 <filter type="static_value" name="type" value="gene_ann" column="2"/>
75b252cf390e Uploaded
devteam
parents:
diff changeset
70 </options>
75b252cf390e Uploaded
devteam
parents:
diff changeset
71 </param>
75b252cf390e Uploaded
devteam
parents:
diff changeset
72
75b252cf390e Uploaded
devteam
parents:
diff changeset
73 <param name="regions" type="select" multiple="True" optional="True" label="Annotation Regions" help="" >
75b252cf390e Uploaded
devteam
parents:
diff changeset
74 <options from_data_table="annovar_indexes">
75b252cf390e Uploaded
devteam
parents:
diff changeset
75 <filter type="data_meta" key="dbkey" ref="input" column="1"/>
75b252cf390e Uploaded
devteam
parents:
diff changeset
76 <filter type="static_value" name="type" value="region" column="2"/>
75b252cf390e Uploaded
devteam
parents:
diff changeset
77 </options>
75b252cf390e Uploaded
devteam
parents:
diff changeset
78 </param>
7
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
79
0
75b252cf390e Uploaded
devteam
parents:
diff changeset
80 <param name="filters" type="select" multiple="True" label="Annotation Databases" help="" >
75b252cf390e Uploaded
devteam
parents:
diff changeset
81 <options from_data_table="annovar_indexes">
75b252cf390e Uploaded
devteam
parents:
diff changeset
82 <filter type="data_meta" key="dbkey" ref="input" column="1"/>
75b252cf390e Uploaded
devteam
parents:
diff changeset
83 <filter type="static_value" name="type" value="filter" column="2"/>
75b252cf390e Uploaded
devteam
parents:
diff changeset
84 </options>
75b252cf390e Uploaded
devteam
parents:
diff changeset
85 </param>
7
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
86
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
87 <param name="out_format" type="select" label="Output data type">
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
88 <option value="vcf">VCF</option>
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
89 <option value="tabular">Tabular</option>
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
90 </param>
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
91
0
75b252cf390e Uploaded
devteam
parents:
diff changeset
92 </inputs>
75b252cf390e Uploaded
devteam
parents:
diff changeset
93
75b252cf390e Uploaded
devteam
parents:
diff changeset
94 <stdio>
75b252cf390e Uploaded
devteam
parents:
diff changeset
95 <regex match=".*" source="both" level="log" description="tool progress"/>
75b252cf390e Uploaded
devteam
parents:
diff changeset
96 </stdio>
75b252cf390e Uploaded
devteam
parents:
diff changeset
97
75b252cf390e Uploaded
devteam
parents:
diff changeset
98 <outputs>
7
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
99 <data name="output" format="tabular">
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
100 <change_format>
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
101 <when input="out_format" value="vcf" format="vcf"/>
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
102 </change_format>
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
103 </data>
0
75b252cf390e Uploaded
devteam
parents:
diff changeset
104 </outputs>
75b252cf390e Uploaded
devteam
parents:
diff changeset
105
75b252cf390e Uploaded
devteam
parents:
diff changeset
106 <tests>
75b252cf390e Uploaded
devteam
parents:
diff changeset
107 </tests>
75b252cf390e Uploaded
devteam
parents:
diff changeset
108
75b252cf390e Uploaded
devteam
parents:
diff changeset
109 <help>
2
9c75a9b5ecd2 Add help to tool.
jeremy goecks <jeremy.goecks@emory.edu>
parents: 0
diff changeset
110 **What it does**
9c75a9b5ecd2 Add help to tool.
jeremy goecks <jeremy.goecks@emory.edu>
parents: 0
diff changeset
111
7
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
112 This tool will annotate variants using specified gene annotations, regions, and filtering databases. Input is a VCF dataset, and output is a table of annotations for each variant in the
08b003ee9db7 Uploaded
devteam
parents: 6
diff changeset
113 VCF dataset or a VCF dataset with the annotations in INFO fields.
2
9c75a9b5ecd2 Add help to tool.
jeremy goecks <jeremy.goecks@emory.edu>
parents: 0
diff changeset
114
9c75a9b5ecd2 Add help to tool.
jeremy goecks <jeremy.goecks@emory.edu>
parents: 0
diff changeset
115 **ANNOVAR Website and Documentation**
9c75a9b5ecd2 Add help to tool.
jeremy goecks <jeremy.goecks@emory.edu>
parents: 0
diff changeset
116
9c75a9b5ecd2 Add help to tool.
jeremy goecks <jeremy.goecks@emory.edu>
parents: 0
diff changeset
117 Website: http://www.openbioinformatics.org/annovar/
9c75a9b5ecd2 Add help to tool.
jeremy goecks <jeremy.goecks@emory.edu>
parents: 0
diff changeset
118
9c75a9b5ecd2 Add help to tool.
jeremy goecks <jeremy.goecks@emory.edu>
parents: 0
diff changeset
119 Paper: http://nar.oxfordjournals.org/content/38/16/e164
9c75a9b5ecd2 Add help to tool.
jeremy goecks <jeremy.goecks@emory.edu>
parents: 0
diff changeset
120
9c75a9b5ecd2 Add help to tool.
jeremy goecks <jeremy.goecks@emory.edu>
parents: 0
diff changeset
121 **Important Usage Note**
9c75a9b5ecd2 Add help to tool.
jeremy goecks <jeremy.goecks@emory.edu>
parents: 0
diff changeset
122
9c75a9b5ecd2 Add help to tool.
jeremy goecks <jeremy.goecks@emory.edu>
parents: 0
diff changeset
123 ANNOVAR is open-source and free for non-profit use. If you use it for commercial purposes, please contact BIOBASE (info@biobase-international.com) directly for license related issues. Also see http://www.openbioinformatics.org/annovar/annovar_faq.html#license
9c75a9b5ecd2 Add help to tool.
jeremy goecks <jeremy.goecks@emory.edu>
parents: 0
diff changeset
124
0
75b252cf390e Uploaded
devteam
parents:
diff changeset
125 </help>
75b252cf390e Uploaded
devteam
parents:
diff changeset
126 </tool>