annotate ensembl_vep.xml @ 2:0f4f67891031 draft default tip

Uploaded
author sh477
date Wed, 06 Apr 2022 16:26:36 +0000
parents c7dcf2635d04
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
1 <tool id="ensembl_vep" name="Predict variant effects" version="105.0" python_template_version="3.5">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
2 <description>with VEP</description>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
3 <macros>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
4 <token name="@VERSION@">105</token>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
5 <xml name="vcf_input">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
6 <param type="data" name="input1" label="VCF input file" format="vcf">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
7 <validator type="unspecified_build" />
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
8 <yield />
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
9 </param>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
10 </xml>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
11 <xml name="vcf_input_validation">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
12 <validator type="dataset_metadata_in_data_table" table_name="vep_versioned_annotation_cache" metadata_name="dbkey" metadata_column="1" message="No annotation caches are available for the specified build" />
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
13 </xml>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
14 </macros>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
15 <requirements>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
16 <requirement type="package" version="@VERSION@.0">ensembl-vep</requirement>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
17 <requirement type="package" version="0.1">perl-math-cdf</requirement>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
18 </requirements>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
19 <command detect_errors="exit_code"><![CDATA[
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
20 #if $annotation_cache.source == "custom":
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
21 #set $custom_ext = $annotation_cache.custom_annotation.ext[:3]
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
22 set -o pipefail &&
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
23 grep -v "#" '${annotation_cache.custom_annotation}' |
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
24 sort -k1,1 -k4,4n -k5,5n -t$'\t' |
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
25 bgzip -c > 'custom_annotation.${custom_ext}.gz' &&
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
26 tabix -p gff 'custom_annotation.${custom_ext}.gz' &&
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
27 #end if
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
28 vep -i '${annotation_cache.input1}' -o MainOutput.vcf --vcf
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
29 #if $annotation_cache.source == "custom":
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
30 --$custom_ext 'custom_annotation.${custom_ext}.gz'
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
31 #else:
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
32 --cache
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
33 --species '${annotation_cache.cache_file.fields.species}'
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
34 --dir_cache '${annotation_cache.cache_file.fields.path}'
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
35 #if $annotation_cache.cache_file.fields.cachetype == "refseq": --refseq
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
36 #if $annotation_cache.cache_file.fields.cachetype == "merged": --merged
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
37 #if $annotation_cache.cache_file.fields.version != "@VERSION@": --cache_version $annotation_cache.cache_file.fields.version
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
38 ## The --offline flag automatically activates --cache. This is not wanted in our gff/gtf case but also not needed as no internet connection is required for annotating with these custom annotation sources.
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
39 --offline
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
40 #end if
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
41 #if $ref_seq.ref_source == "cached":
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
42 --fasta '${ref_seq.ref.fields.path}'
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
43 #elif $ref_seq.ref_source == "history":
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
44 --fasta '${ref_seq.ref}'
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
45 #end if
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
46 --stats_text
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
47
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
48 #if $out_opt.sift != "None": $out_opt.sift
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
49 #if $out_opt.polyphen != "None": $out_opt.polyphen
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
50 #if $out_opt.nearest != "None": $out_opt.nearest
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
51 #if int($out_opt.distance_custom.distance_1) > -1:
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
52 --distance $out_opt.distance_custom.distance_1#if int($out_opt.distance_custom.distance_2) > -1: ,$out_opt.distance_custom.distance_2
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
53 #end if
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
54 #if $out_opt.cell_type != "": --cell_type '$out_opt.cell_type'
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
55 #if $out_opt.individual != "": --individual $out_opt.individual
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
56 --vcf_info_field $out_opt.vcf_info_type.vcf_info_field
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
57 #if $out_opt.terms != "None": $out_opt.terms
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
58 #if $out_opt.out_opt_checkboxes != "None": ${' '.join(str($out_opt.out_opt_checkboxes).split(","))}
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
59 #if $out_opt.shift_var.shift_selector != "None":
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
60 $out_opt.shift_var.shift_selector
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
61 #if $out_opt.shift_var.shift_selector == "--shift_hgvs 0 --shift_3prime 1"
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
62 #if $out_opt.shift_var.shift_length != "None": $out_opt.shift_var.shift_length
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
63 #end if
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
64 #end if
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
65 #if $ident.input_synonyms: --synonyms '${ident.input_synonyms}'
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
66 #if $ident.ident_checkboxes != "None": ${' '.join(str($ident.ident_checkboxes).split(","))}
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
67 #if $colo_var.colo_var_checkboxes != "None": ${' '.join(str($colo_var.colo_var_checkboxes).split(","))}
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
68 #if $fil_qc.most_severe != "None": $fil_qc.most_severe
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
69 #if $fil_qc.fil_qc_checkboxes != "None": ${' '.join(str($fil_qc.fil_qc_checkboxes).split(","))}
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
70 #if $plugins.carol != "": $plugins.carol
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
71 #if $plugins.condel != "": $plugins.condel
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
72 #if $plugins.exacpli.exacpli_bool == "true": --plugin ExACpLI,'${plugins.exacpli.exacpli_file}'
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
73 #if $plugins.loftool.loftool_bool == "true": --plugin LoFtool,'${plugins.loftool.loftool_file}'
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
74 ]]></command>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
75 <inputs>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
76 <conditional name="annotation_cache">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
77 <param name="source" type="select" label="Select source of annotation data" help="Ensembl strongly recommends to only use annotation cache files with a version number matching the VEP version. You can disable the corresponding filtering of available cache files at your own risk. This does not apply if you select a GFF/GTF annotation source.">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
78 <option value="restricted">VEP cache file with matching version number</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
79 <option value="unrestricted">Any VEP cache file</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
80 <option value="custom">GFF or GTF from history</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
81 </param>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
82 <when value="restricted">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
83 <expand macro="vcf_input">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
84 <expand macro="vcf_input_validation" />
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
85 </expand>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
86 <param name="cache_file" type="select" label="Select annotation cache file" help="If the annotation data of interest is not listed, have a look at all available cache files regardless of their version number or contact your Galaxy admin.">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
87 <options from_data_table="vep_versioned_annotation_cache">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
88 <filter type="static_value" value="@VERSION@" column="2" />
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
89 <filter type="sort_by" column="4"/>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
90 </options>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
91 <validator type="no_options" message="No annotation caches are available"/>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
92 </param>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
93 </when>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
94 <when value="unrestricted">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
95 <expand macro="vcf_input">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
96 <expand macro="vcf_input_validation" />
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
97 </expand>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
98 <param name="cache_file" type="select" label="Select annotation cache file" help="If the annotation data of interest is not listed, contact your Galaxy admin.">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
99 <options from_data_table="vep_versioned_annotation_cache">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
100 <filter type="sort_by" column="4"/>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
101 </options>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
102 <validator type="no_options" message="No annotation caches are available"/>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
103 </param>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
104 </when>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
105 <when value="custom">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
106 <expand macro="vcf_input" />
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
107 <param name="custom_annotation" type="data" format="gff,gtf" label="Select GFF or GTF annotation file from history" help="Choosing this option requires that you also supply a Fasta file as reference genome." />
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
108 </when>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
109 </conditional>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
110 <conditional name="ref_seq">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
111 <param name="ref_source" type="select" label="Use FASTA file as reference sequence (optional)" help="Must be specified if using a GFF/GTF annotation source or if fetching HGVS or SPDI notations.">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
112 <option value="no_ref">Do not use extra reference sequence</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
113 <option value="cached">Locally cached</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
114 <option value="history">History</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
115 </param>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
116 <when value="no_ref" />
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
117 <when value="cached">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
118 <param name="ref" type="select" label="Select reference sequence">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
119 <options from_data_table="fasta_indexes">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
120 <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file" />
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
121 </options>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
122 </param>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
123 </when>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
124 <when value="history">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
125 <param name="ref" type="data" format="fasta" label="Select reference sequence" />
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
126 </when>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
127 </conditional>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
128 <section name="out_opt" title="Output options">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
129 <param name="sift" type="select" optional="true" label="Output SIFT prediction" help="SIFT predicts whether an amino acid substitution affects protein function based on sequence homology and the physical properties of amino acids.">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
130 <option value="--sift p">Prediction term only</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
131 <option value="--sift s">Score only</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
132 <option value="--sift b">Both</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
133 </param>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
134 <param name="polyphen" type="select" optional="true" label="Output PolyPhen prediction" help="PolyPhen is a tool which predicts possible impact of an amino acid substitution on the structure and function of a human protein using straightforward physical and comparative considerations. VEP uses the humVar score by default.">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
135 <option value="--polyphen p">Prediction term only</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
136 <option value="--polyphen s">Score only</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
137 <option value="--polyphen b">Both</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
138 </param>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
139 <param name="nearest" type="select" optional="true" label="Retrieve transcript or gene with nearest TSS to each input variant" help="Retrieve the transcript or gene with the nearest protein-coding transcription start site (TSS) to each input variant. Note that the nearest TSS may not belong to a transcript that overlaps the input variant, and more than one may be reported in the case where two are equidistant from the input coordinates.">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
140 <option value="--nearest transcript">Nearest transcript ID</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
141 <option value="--nearest gene">Nearest gene ID</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
142 <option value="--nearest symbol">Nearest gene symbol</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
143 </param>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
144
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
145 <conditional name="distance_custom">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
146 <param name="distance_custom_selector" type="select" label="Modify the distance up and/or downstream between a variant and a transcript for which VEP will assign the upstream_gene_variant or downstream_gene_variant consequences" help="Default: 5000. Upstream is 5' and downstream 3' direction.">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
147 <option value="default" selected="true">Default</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
148 <option value="one_dist">Custom distance used for both upstream and downstream</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
149 <option value="two_dist">Custom upstream distance and different custom downstream distance</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
150 </param>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
151 <when value="default">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
152 <param name="distance_1" type="hidden" value="-1"/>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
153 <param name="distance_2" type="hidden" value="-1"/>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
154 </when>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
155 <when value="one_dist">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
156 <param name="distance_1" type="integer" min="0" value="5000" label="Enter custom upstream and downstream distance"/>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
157 <param name="distance_2" type="hidden" value="-1"/>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
158 </when>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
159 <when value="two_dist">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
160 <param name="distance_1" type="integer" min="0" value="5000" label="Enter custom upstream distance"/>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
161 <param name="distance_2" type="integer" min="0" value="5000" label="Enter custom downstream distance"/>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
162 </when>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
163 </conditional>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
164
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
165 <param name="cell_type" type="text" optional="true" label="Report only regulatory regions that are found in the given cell type(s):" help="Recommended for advanced users only. Can be a single cell type or a comma-separated list. The functional type in each cell type is reported under CELL_TYPE in the output."/>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
166 <param name="individual" type="text" optional="true" label="Consider only alternate alleles present in the genotypes of the specified individual(s):" help="Enter the individual's IDs as comma-separated list. Individual variant combinations homozygous for the given reference allele will not be reported. Each individual and variant combination is given on a separate line of output. Only works with VCF files containing individual genotype data." />
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
167 <conditional name="vcf_info_type">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
168 <param name="vcf_info_type_selector" type="select" label="Change name of the consequences INFO column in VCF output" help="Default: CSQ. Use ANN for compatibility with other tools such as snpEff">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
169 <option value="csq" selected="true">CSQ</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
170 <option value="ann">ANN</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
171 <option value="custom">Custom</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
172 </param>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
173 <when value="csq">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
174 <param name="vcf_info_field" type="hidden" value="CSQ"/>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
175 </when>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
176 <when value="ann">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
177 <param name="vcf_info_field" type="hidden" value="ANN"/>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
178 </when>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
179 <when value="custom">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
180 <param name="vcf_info_field" type="text" label="Enter custom INFO key"/>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
181 </when>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
182 </conditional>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
183
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
184 <param name="terms" type="select" optional="true" label="Type of consequence terms to output" help="The default used for terms is Sequence Ontology.">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
185 <option value="--terms SO">Sequence Ontology (SO)</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
186 <option value="--terms display">Display version of SO</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
187 <option value="--terms NCBI">NCBI</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
188 </param>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
189
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
190 <conditional name="shift_var">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
191 <param name="shift_selector" type="select" label="Shift variants to the right">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
192 <option value="" selected="true">No shift</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
193 <option value="--shift_hgvs 1">3' shift of HGVS notations, causing ambiguous insertions or deletions (typically in repetetive sequence tracts) to be "shifted" to their most 3' possible coordinates (relative to the transcript sequence and strand) before the HGVS notations are calculated</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
194 <option value="--shift_hgvs 0 --shift_3prime 1">Right align all variants relative to their associated transcripts prior to consequence calculation</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
195 <option value="--shift_hgvs 0 --shift_genomic 1">Right align all variants, including intergenic variants, before consequence calculation and update the Location field</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
196 </param>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
197 <when value=""/>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
198 <when value="--shift_hgvs 1"/>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
199 <when value="--shift_hgvs 0 --shift_3prime 1">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
200 <param name="shift_length" type="boolean" truevalue="--shift_length" falsevalue="" label="Report the distance each variant has been shifted"/>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
201 </when>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
202 <when value="--shift_hgvs 0 --shift_genomic 1"/>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
203 </conditional>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
204
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
205 <param name="out_opt_checkboxes" type="select" optional="true" display="checkboxes" multiple="true" label="Output option flags">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
206 <option value="--variant_class">Ouput variant class</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
207 <option value="--humdiv">Retrieve humDiv PolyPhen prediction instead of humVar</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
208 <option value="--overlaps">Output overlap between transcript and structural variant</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
209 <option value="--gene_phenotype">Indicate if the overlapped gene is associated with a phenotype, disease or trait</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
210 <option value="--regulatory">Look for overlaps with regulatory regions</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
211 <option value="--phased">Force VCF genotypes to be interpreted as phased</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
212 <option value="--allele_number">Identify allele number from VCF input, where 1 = first ALT allele etc.</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
213 <option value="--show_ref_allele">Adds the reference allele in the output</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
214 <option value="--total_length">Give cDNA, CDS and protein positions as Position/Length</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
215 <option value="--numbers">Output affected exon and intron numbering</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
216 <option value="--no_escape">Don't URI escape HGVS strings</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
217 <option value="--keep_csq">Don't overwrite existing CSQ entry in VCF INFO field</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
218 <option value="--no_headers">Don't write header lines in output files</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
219 </param>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
220 </section>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
221 <section name="ident" title="Identifiers">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
222 <param type="data" optional="true" name="input_synonyms" format="tsv" label="Load a file of chromosome synonyms" help="File should be tab-delimited with the primary identifier in column 1 and the synonym in column 2. Synonyms allow different chromosome identifiers to be used in the input file and any annotation source."/>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
223 <param name="ident_checkboxes" type="select" optional="true" display="checkboxes" multiple="true" label="Identifier flags">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
224 <option value="--hgvs">Add HGVS nomenclature, both coding and protein sequence names, to the ouput (requires FASTA)</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
225 <option value="--hgvsg">Add genomic HGVS nomenclature based on the input chromosome name (requires FASTA)</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
226 <option value="--spdi">Add genomic SPDI notation (requires FASTA)</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
227 <option value="--transcript_version">Add version numbers to Ensembl transcript identifiers</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
228 <option value="--protein">Add the Ensembl protein identifier to the output where appropriate</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
229 <option value="--symbol">Add the gene symbol (e.g. HGNC) (where available) to the output</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
230 <option value="--ccds">Add the CCDS transcript identifer (where available) to the output</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
231 <option value="--uniprot">Add best match accessions for translated protein products from three UniProt-related databases (SWISSPROT, TREMBL and UniParc) to the output</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
232 <option value="--tsl">Add the transcript support level for this transcript to the output (only for hg38)</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
233 <option value="--appris">Add the APPRIS isoform annotation for this transcript to the output (only for hg38)</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
234 <option value="--canonical">Add a flag indicating if the transcript is the canonical transcript for the gene</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
235 <option value="--mane">Add a flag indicating if the transcript is the MANE Select or MANE Plus Clinical transcript for the gene (only for hg38)</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
236 <option value="--mane_select">Add a flag indicating if the transcript is the MANE Select transcript for the gene (only for hg38)</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
237 <option value="--biotype">Output the biotype of the transcript or regulatory feature</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
238 <option value="--domains">Add names of overlapping protein domains to output</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
239 <option value="--xref_refseq">Output aligned RefSeq mRNA identifier for transcript</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
240 </param>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
241 </section>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
242 <section name="colo_var" title="Co-located variants">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
243 <param name="colo_var_checkboxes" type="select" optional="true" display="checkboxes" multiple="true" label="Co-located variants flags">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
244 <option value="--check_existing">Check for the existence of known variants that are co-located with the input</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
245 <option value="--clin_sig_allele 0">Report all known clinical significance values at the given locus (instead of allele-specific)</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
246 <option value="--exclude_null_alleles">Do not include variants with unknown alleles when checking for co-located variants</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
247 <option value="--no_check_alleles">When checking for existing variants, compare using coordinates only</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
248 <option value="--af">Add the global allele frequency (AF) from 1000 Genomes Phase 3 data for any known co-located variant to the output</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
249 <option value="--max_af">Report the highest allele frequency observed in any population from 1000 genomes, ESP or gnomAD</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
250 <option value="--af_1kg">Add allele frequency from continental populations (AFR,AMR,EAS,EUR,SAS) of 1000 Genomes Phase 3 to the output</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
251 <option value="--af_esp">Include allele frequency from NHLBI-ESP populations</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
252 <option value="--af_gnomad">Include allele frequency from Genome Aggregation Database (gnomAD) exome populations</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
253 <option value="--af_exac">Include allele frequency from ExAC project populations</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
254 <option value="--pubmed">Report Pubmed IDs for publications that cite existing variant</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
255 <option value="--var_synonyms">Report known synonyms for co-located variants</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
256 <option value="--failed 1">Do not exclude variants that have been flagged as failed when checking for co-located variants</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
257 </param>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
258 </section>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
259 <section name="fil_qc" title="Filtering and QC options">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
260 <param name="most_severe" type="boolean" optional="true" label="Output only the most severe consequence per variant"
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
261 truevalue="--most_severe" falsevalue=""
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
262 help="Transcript-specific columns will be left blank. Incompatible with the checkbox flags of this section, the Identifier flags as well as the SIFT, PolyPhen and exon/intron numbering flags from Output options."/>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
263 <param name="fil_qc_checkboxes" type="select" optional="true" display="checkboxes" multiple="true" label="Filtering and QC flags">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
264 <option value="--coding_only">Only return consequences that fall in the coding regions of transcripts</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
265 <option value="--no_intergenic">Do not include intergenic consequences in the output</option>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
266 </param>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
267 </section>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
268 <section name="plugins" title="VEP Plugins">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
269 <param name="carol" type="boolean" label="Enable Carol plugin" truevalue="--plugin Carol" falsevalue="" help="This plugin calculates the Combined Annotation scoRing toOL (CAROL) score for a missense mutation and adds it to VEP's output. Both the SIFT and PolyPhen-2 scores are required for the calculation, so these two have to be activated in the output options section." />
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
270 <param name="condel" type="boolean" label="Enable Condel plugin" truevalue="--plugin Condel" falsevalue="" help="This plugin calculates the Consensus Deleteriousness (Condel) score for a missense mutation and adds it to VEP's output. Both the SIFT and PolyPhen-2 scores are required for the calculation, so these two have to be activated in the output options section." />
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
271 <conditional name="exacpli">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
272 <param name="exacpli_bool" type="boolean" label="Enable ExACpLI plugin" help="This plugin calculates the probabililty of a gene being loss-of-function intolerant (pLI) and adds it to VEP's output. The closer pLI is to 1, the more likely the gene is loss-of-function (LoF) intolerant. An ExACpLI_values.txt file is required for usage and it is recommended to use the one provided in the VEP_plugins GitHub repository: https://github.com/Ensembl/VEP_plugins" />
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
273 <when value="false" />
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
274 <when value="true">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
275 <param name="exacpli_file" type="data" format="txt" label="Select ExACpLI_values text file" />
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
276 </when>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
277 </conditional>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
278 <conditional name="loftool">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
279 <param name="loftool_bool" type="boolean" label="Enable LoFtool plugin" help="This plugin calculates LoFtool scores and adds them to VEP's output. LoFtool provides a rank of genic intolerance and consequent susceptibility to disease based on the ratio of Loss-of-function (LoF) to synonymous mutations for each gene in 60,706 individuals from ExAC, adjusting for the gene de novo mutation rate and evolutionary protein conservation. The lower the LoFtool gene score percentile the most intolerant is the gene to functional variation. A LoFtool_scores.txt file is required for usage and it is recommended to use the one provided in the VEP_plugins GitHub repository: https://github.com/Ensembl/VEP_plugins" />
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
280 <when value="false" />
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
281 <when value="true">
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
282 <param name="loftool_file" type="data" format="txt" label="Select LoFtool_scores text file" />
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
283 </when>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
284 </conditional>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
285 </section>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
286 </inputs>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
287 <outputs>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
288 <data name="output1" format="vcf" from_work_dir="MainOutput.vcf" />
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
289 <data name="output2" format="txt" label="${tool.name} on ${on_string} TXT Summary" from_work_dir="MainOutput.vcf_summary.txt" />
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
290 </outputs>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
291 <tests>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
292 <test>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
293 <param name="source" value="restricted" />
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
294 <param name="input1" dbkey="dm6" value="input_test1.vcf" ftype="vcf" />
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
295 <param name="cache_file" value="drosophila_melanogaster_vep_105_BDGP6.32" />
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
296 <output name="output1" file="output_test1.vcf" ftype="vcf" lines_diff="2" />
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
297 </test>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
298 <test>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
299 <param name="source" value="custom" />
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
300 <param name="input1" dbkey="hg19" value="input_test2.vcf" ftype="vcf" />
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
301 <param name="custom_annotation" dbkey="hg19" value="test.gtf" ftype="gtf" />
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
302 <param name="ref_source" value="history" />
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
303 <param name="ref" dbkey="hg19" value="test.fa" ftype="fasta" />
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
304 <output name="output1" file="output_test2.vcf" ftype="vcf" lines_diff="2" />
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
305 </test>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
306 </tests>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
307 <help><![CDATA[
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
308 The Ensembl Variant Effect Predictor (VEP) is able to determine the effect of variants (e.g. SNPs, insertions or deletions) on genes, transcripts, protein sequences and regulatory regions. Given the coordinates and nucleotide changes of a variant, it outputs affected genes, the exact location and consequences of the variant as well as known variants matching this one.
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
309 ]]></help>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
310 <citations>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
311 <citation type="doi">10.1186/s13059-016-0974-4</citation>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
312 </citations>
c7dcf2635d04 Uploaded
sh477
parents:
diff changeset
313 </tool>