annotate vep_unico.xml @ 3:ca1e48c52db9 draft

Uploaded
author elixir-it
date Sat, 21 Sep 2019 13:23:01 -0400
parents bfd92976550f
children e82c4e48ecd7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
1 <tool id="vep-unico" name="vep-unico" version="1.0.0">
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
2 <description>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
3 wrapper for variant-effect-predictor86 and vcf2maf
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
4 </description>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
5 <macros>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
6 <import>vep-unico-macros.xml</import>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
7 <import>vcf2maf-macros.xml</import>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
8 <import>vep-download-cache-macros.xml</import>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
9 <import>vep-annotate-macros.xml</import>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
10 </macros>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
11 <requirements>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
12 <requirement type="package" version="86">variant-effect-predictor</requirement>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
13 <requirement type="package" version="1.3.1">samtools</requirement>
3
ca1e48c52db9 Uploaded
elixir-it
parents: 2
diff changeset
14 <requirement type="package" version="1.0" >openssl</requirement>
0
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
15 </requirements>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
16 <command><![CDATA[
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
17 #if str($veptools.veptoolsselect) =="downloadcache"
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
18
3
ca1e48c52db9 Uploaded
elixir-it
parents: 2
diff changeset
19 cd \$CONDA_PREFIX && [[ -d vep_cache ]] || mkdir vep_cache ;
0
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
20 cd bin && perl vep_install.pl
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
21 -a ac -s $veptools.species
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
22 --NO_HTSLIB
3
ca1e48c52db9 Uploaded
elixir-it
parents: 2
diff changeset
23 --CACHEDIR \$CONDA_PREFIX/vep_cache;
0
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
24 ## write the cache file downloaded
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
25 echo "CACHE DOWNLOADED YET">$output1;
3
ca1e48c52db9 Uploaded
elixir-it
parents: 2
diff changeset
26 ls \$CONDA_PREFIX/vep_cache/*/ >> $output1;
0
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
27 #end if
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
28
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
29
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
30 #if str($veptools.veptoolsselect) =="annotate"
3
ca1e48c52db9 Uploaded
elixir-it
parents: 2
diff changeset
31 perl \$CONDA_PREFIX/bin/variant_effect_predictor.pl
2
bfd92976550f Uploaded
elixir-it
parents: 1
diff changeset
32 --fork 4
0
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
33 --offline
3
ca1e48c52db9 Uploaded
elixir-it
parents: 2
diff changeset
34 --dir \$CONDA_PREFIX/vep_cache
0
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
35 --force_overwrite
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
36 #if $veptools.everything.value
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
37 --everything
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
38 #end if
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
39 --species $veptools.species
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
40 --buffer_size $veptools.buffer
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
41 --vcf
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
42 --input_file $veptools.input
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
43 --output_file $output2
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
44 --stats_file stat.htm
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
45 #end if
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
46
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
47
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
48 #if str($veptools.veptoolsselect) =="vcf2maf"
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
49 ln -s $veptools.input_vcf ./input.vcf;
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
50 perl $__tool_directory__/vcf2maf.pl
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
51 --input-vcf ./input.vcf
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
52 --output-maf $output_maf
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
53 --vep-forks 1
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
54 --tumor-id $veptools.tumour_id
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
55 --normal-id $veptools.normal_id
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
56 --buffer-size $veptools.buffer
3
ca1e48c52db9 Uploaded
elixir-it
parents: 2
diff changeset
57 --vep-path \$CONDA_PREFIX/bin/
ca1e48c52db9 Uploaded
elixir-it
parents: 2
diff changeset
58 --vep-data \$CONDA_PREFIX/vep_cache
ca1e48c52db9 Uploaded
elixir-it
parents: 2
diff changeset
59
ca1e48c52db9 Uploaded
elixir-it
parents: 2
diff changeset
60
ca1e48c52db9 Uploaded
elixir-it
parents: 2
diff changeset
61
ca1e48c52db9 Uploaded
elixir-it
parents: 2
diff changeset
62
ca1e48c52db9 Uploaded
elixir-it
parents: 2
diff changeset
63
ca1e48c52db9 Uploaded
elixir-it
parents: 2
diff changeset
64 #if $veptools.reference_source.reference_source_selector == "history"
ca1e48c52db9 Uploaded
elixir-it
parents: 2
diff changeset
65 --ref-fasta $veptools.reference_source.reference
ca1e48c52db9 Uploaded
elixir-it
parents: 2
diff changeset
66 #end if
ca1e48c52db9 Uploaded
elixir-it
parents: 2
diff changeset
67 #if $veptools.reference_source.reference_source_selector == "cached"
ca1e48c52db9 Uploaded
elixir-it
parents: 2
diff changeset
68 --ref-fasta $veptools.reference_source.ref_file.fields.path
ca1e48c52db9 Uploaded
elixir-it
parents: 2
diff changeset
69 #end if
ca1e48c52db9 Uploaded
elixir-it
parents: 2
diff changeset
70
ca1e48c52db9 Uploaded
elixir-it
parents: 2
diff changeset
71 --species $veptools.species
ca1e48c52db9 Uploaded
elixir-it
parents: 2
diff changeset
72 --filter-vcf 0 ;
0
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
73
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
74 #end if
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
75 ]]>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
76 </command>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
77 <inputs>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
78 <conditional name="veptools">
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
79 <param name="veptoolsselect" type="select" label="vep">
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
80 <option value="downloadcache" selected="true">vep-download-cache</option>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
81 <option value="annotate">vep-annotate</option>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
82 <option value="vcf2maf">vcf2maf</option>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
83 </param>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
84 <when value="downloadcache">
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
85 <expand macro="list-cache"/>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
86 </when>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
87 <when value="annotate">
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
88 <expand macro="vep-annotate-inputs-macro"/>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
89 <expand macro="list-cache-annotate"/>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
90 </when>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
91 <when value="vcf2maf">
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
92 <expand macro="vcf2maf-inputs-macro"/>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
93 <expand macro="list-vcf2maf"/>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
94 </when>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
95 </conditional>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
96 </inputs>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
97 <outputs>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
98 <!--vep-download-cache-outputs-->
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
99 <data format="txt" name="output1" label="cache downloaded">
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
100 <filter>veptools['veptoolsselect'] == 'downloadcache'</filter>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
101 </data>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
102 <!--vep-annotate-outputs-->
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
103 <data format="vcf" name="output2" label="vep-annotated on ${on_string} ">
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
104 <filter>veptools['veptoolsselect'] == 'annotate'</filter>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
105 </data>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
106 <data format="html" name="stat" from_work_dir="stat.htm" label="stat on ${on_string}">
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
107 <filter>veptools['veptoolsselect'] == 'annotate'</filter>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
108 </data>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
109 <!--vcf2maf-outputs-->
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
110 <data name="output_maf" format="maf" label="vcf2maf on ${on_string} ">
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
111 <filter>veptools['veptoolsselect'] == 'vcf2maf'</filter>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
112 </data>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
113 </outputs>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
114 <stdio>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
115 <exit_code range="1:" level="fatal" description="Failure" />
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
116 </stdio>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
117 <citations>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
118 <citation type="doi">10.1186/s13059-016-0974-4</citation>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
119 </citations>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
120 <help>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
121 **IMPORTANT**
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
122 before running vep_annotate or vcf2maf tool for the first time you have to download the cache file using vep_download_cache
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
123
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
124 **what it does**
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
125
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
126 - **vep_annotate** determines the effect of your variants (SNPs, insertions, deletions, CNVs or structural variants) on genes, transcripts, and protein sequence, as well as regulatory regions.
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
127
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
128 - **vep_download_cache** download the cache file, used by vep v.86.It is a file containing all transcript models, regulatory features and variant data for a species.
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
129
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
130 - **vcf2maf** convert vcf in MAF format calling vep_annotate.
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
131
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
132 </help>
786c9295d2be Uploaded
elixir-it
parents:
diff changeset
133 </tool>