annotate annotate_variants.xml @ 2:ed31cab0b327 draft

Uploaded
author wolma
date Sat, 13 Dec 2014 18:52:44 -0500
parents fe2ff108038d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
1 <tool id="annotate_variants" name="Variant Annotation">
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
2 <description>Predict the effects of SNPs and indels on known genes in the reference genome using SnpEff</description>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
3 <requirements>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
4 <requirement type="package" version="0.1.5">mimodd</requirement>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
5 </requirements>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
6 <version_command>mimodd version -q</version_command>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
7 <command>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
8 mimodd annotate
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
9
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
10 $inputfile
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
11
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
12 #if $str($annotool.name)=='snpeff':
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
13 --genome "${annotool.genomeVersion}"
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
14 #if $annotool.ori_output:
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
15 --snpeff-out $snpeff_file
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
16 #end if
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
17 #if $annotool.stats:
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
18 --stats $summary_file
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
19 #end if
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
20 ${annotool.snpeff_settings.chr} ${annotool.snpeff_settings.no_us} ${annotool.snpeff_settings.no_ds} ${annotool.snpeff_settings.no_intron} ${annotool.snpeff_settings.no_intergenic} ${annotool.snpeff_settings.no_utr}
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
21 #if $annotool.snpeff_settings.min_cov:
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
22 --minC ${annotool.snpeff_settings.min_cov}
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
23 #end if
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
24 #if $annotool.snpeff_settings.min_qual:
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
25 --minQ ${annotool.snpeff_settings.min_qual}
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
26 #end if
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
27 #if $annotool.snpeff_settings.ud:
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
28 --ud ${annotool.snpeff_settings.ud}
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
29 #end if
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
30 #end if
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
31
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
32 --ofile $outputfile
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
33 #if $str($formatting.oformat) == "text":
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
34 --oformat text
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
35 #end if
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
36 #if $str($formatting.oformat) == "html":
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
37 #if $formatting.formatter_file:
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
38 --link ${formatting.formatter_file}
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
39 #end if
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
40 #if $formatting.species
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
41 --species "${formatting.species}"
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
42 #end if
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
43 #end if
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
44
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
45 #if $str($grouping):
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
46 --grouping $grouping
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
47 #end if
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
48 --verbose
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
49 </command>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
50
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
51 <inputs>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
52 <param name="inputfile" type="data" format="vcf" label="vcf inputfile to be annotated" />
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
53 <param name="grouping" type="select" label="Group variants by">
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
54 <option value="">order in the input file</option>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
55 <option value="by_sample">sample</option>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
56 <option value="by_genes">most affected genes</option>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
57 </param>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
58 <conditional name="formatting">
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
59 <param name="oformat" type="select" label="Format of the annotation output file">
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
60 <option value="html">HTML</option>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
61 <option value="text">Tab-separated plain text</option>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
62 </param>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
63 <when value="html">
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
64 <param name="formatter_file" type="data" format="txt" optional="true" label="Optional file with hyperlink formatting instructions" />
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
65 <param name="species" type="text" label="Species" help="Overwrite the species guess from the SnpEff genome, often not necessary" />
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
66 </when>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
67 </conditional>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
68 <conditional name="annotool">
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
69 <param name="name" type="select" label="Use this tool to annotate the input file" help = "Select SnpEff here, if you want to have the vcf input annotated with genomic feature information. Select None if you do not want additional annotation, if you do not have SnpEff installed, or if you have no appropriate SnpEff annotation file for the input.">
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
70 <option value="snpeff">SnpEff</option>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
71 <option value="None">None</option>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
72 </param>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
73 <when value="snpeff">
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
74 <param name="genome_list" type="data" format="tabular" label="genome list" />
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
75 <param name="genomeVersion" type="select" label="Genome">
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
76 <options from_dataset="genome_list">
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
77 <column name="name" index="0"/>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
78 <column name="value" index="1"/>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
79 </options>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
80 </param>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
81 <param name="ori_output" type="boolean" checked="true" label="Keep the original SnpEff output" />
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
82 <param name="stats" type="boolean" checked="true" label="Produce a summary file of results" />
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
83
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
84 <conditional name="snpeff_settings">
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
85 <param name="detail_level" type="select" label="SnpEff-specific parameter settings" help="This section lets you specify the detailed parameter settings for the SnpEff tool.">
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
86 <option value="default">default settings</option>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
87 <option value="change">change settings</option>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
88 </param>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
89 <when value="default">
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
90 ## default settings for SnpEff
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
91 <param name="chr" type="hidden" value=""/>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
92 <param name="min_cov" type="hidden" value=""/>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
93 <param name="min_qual" type="hidden" value=""/>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
94 <param name="no_ds" type="hidden" value=""/>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
95 <param name="no_us" type="hidden" value=""/>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
96 <param name="no_intron" type="hidden" value=""/>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
97 <param name="no_intergenic" type="hidden" value=""/>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
98 <param name="no_utr" type="hidden" value=""/>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
99 <param name="ud" type="hidden" value=""/>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
100 </when>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
101 <when value="change">
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
102 <param name="chr" type="boolean" truevalue="-chr" falsevalue="" checked="false" label="prepend 'chr' to chromosome names, e.g., 'chr7' instead of '7'" />
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
103 <param name="min_cov" type="integer" optional="true" label="minimum coverage (default = not used)" help="do not include variants with a coverage lower than this value"/>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
104 <param name="min_qual" type="integer" optional="true" label="minimum quality (default = not used)" help="do not include variants with a quality lower than this value"/>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
105 <param name="no_ds" type="boolean" label="do not show downstream changes" truevalue="--no-downstream" falsevalue="" checked="false" help="annotation of effects on the downstream region of genes can be suppressed"/>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
106 <param name="no_us" type="boolean" label="do not show upstream changes" truevalue="--no-upstream" falsevalue="" checked="false" help="annotation of effects on the upstream region of genes can be suppressed"/>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
107 <param name="no_intron" type="boolean" label="do not show intron changes" truevalue="--no-intron" falsevalue="" checked="false" help="annotation of effects on introns of genes can be suppressed"/>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
108 <param name="no_intergenic" type="boolean" label="do not show intergenic changes" truevalue="--no-intergenic" falsevalue="" checked="false" help="annotation of effects on intergenic regions can be suppressed"/>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
109 <param name="no_utr" type="boolean" label="do not show UTR changes" truevalue="--no-utr" falsevalue="" checked="false" help="annotation of effects on the untranslated regions of genes can be suppressed"/>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
110 <param name="ud" type="integer" optional="true" label="upstream downstream interval length (default = 5000 bases)" help="specify the upstream/downstream interval length, i.e., variants more than INTERVAL nts from the next annotated gene are considered to be intergenic"/>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
111 </when>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
112 </conditional>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
113 </when>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
114 </conditional>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
115 </inputs>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
116
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
117 <outputs>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
118 <data name="outputfile" format="html" >
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
119 <change_format>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
120 <when input="formatting.oformat" value="text" format="tabular"/>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
121 </change_format>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
122 </data>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
123 <data name="snpeff_file" format="vcf" >
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
124 <filter>(annotool['name']=="snpeff" and annotool['ori_output'])</filter>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
125 </data>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
126 <data name="summary_file" format="html">
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
127 <filter>(annotool['name']=="snpeff" and annotool['stats'])</filter>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
128 </data>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
129 </outputs>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
130
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
131 <help>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
132 .. class:: infomark
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
133
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
134 **What it does**
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
135
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
136 The tool turns a variant list in VCF format into a more readable summary table listing variant sites and effects.
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
137
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
138 If installed, the variant annotation tool SnpEff can be used transparently to determine the genomic features, e.g., genes or transcripts, affected by the variants.
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
139
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
140 Use of this feature requires that you have an appropriate SnpEff genome file installed on the host machine. You can use the *List installed SnpEff genomes* tool to generate a list of all available SnpEff genomes.
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
141 This list can then be used (by selecting the dataset as the *genome list*) to populate the *genome* dropdown menu, from which you can select the SnpEff genome file to be used for the annotation.
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
142
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
143 As output file formats HTML or plain text are supported.
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
144 In HTML mode, variant positions and/or affected genomic features can be turned into hyperlinks to corresponding views in web-based genome browsers and databases.
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
145
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
146 The behavior of this feature depends on:
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
147
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
148 1) Recognition of the species that is analyzed
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
149
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
150 You can declare the species you are working with using the *Species* text field.
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
151 If you are not declaring the species explicitly, but are choosing SnpEff for effect annotation, the tool will usually be able to auto-detect the species from the SnpEff genome you are using.
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
152 If no species gets assigned in either way, no hyperlinks will be generated and the html output will look essentially like plain text.
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
153
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
154 2) Available hyperlink formatting rules for this species
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
155
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
156 When the species has been recognized, the tool checks if you have selected an *optional file with hyperlink formatting instructions*.
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
157 If you did and that file contains an entry matching the recognized species, that entry will be used as a template to construct the hyperlinks.
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
158 If no matching entry is found in the file, an error will be raised.
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
159
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
160 If you did not supply a hyperlink formatting instruction file, the tool will consult an internal lookup table to see if it finds default rules for the construction of the hyperlinks for the species.
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
161 If not, no hyperlinks will be generated and the html output will look essentially like plain text.
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
162
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
163 **TIP:**
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
164 MiModD's internal hyperlink formatting lookup tables are maintained and growing with every new version, but since weblinks are changing frequently as well, it is possible that you will encounter broken hyperlinks for your species of interest. In such a case, you can resort to two things: `tell us about the problem`_ to make sure it gets fixed in the next release and, in the meantime, use a custom file with hyperlink formatting instructions to overwrite the default entry for your species.
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
165
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
166 .. _tell us about the problem: mailto:mimodd@googlegroups.com
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
167 </help>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
168 </tool>
fe2ff108038d Imported from capsule None
wolma
parents:
diff changeset
169