Mercurial > repos > iuc > snpeff

annotate snpEff_macros.xml @ 31:b7029a54f73e draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 4cc10cfe702828a91ecf8bb58d3f84a36b0578f7
author iuc
date Mon, 21 Oct 2024 13:55:59 +0000
parents 030fe29d4c47
children ebe9fd7e5bd1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
39bac90c773d Uploaded
iuc
parents:
diff changeset
1 <macros>
14
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
2 <xml name="requirement">
31
b7029a54f73e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 4cc10cfe702828a91ecf8bb58d3f84a36b0578f7
iuc
parents: 29
diff changeset
3 <requirement type="package" version="5.2">snpeff</requirement>
27
c6422110bc0b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 67da1a478db26ad45f36a673218d526f8962d72f"
iuc
parents: 21
diff changeset
4 <yield/>
0
39bac90c773d Uploaded
iuc
parents:
diff changeset
5 </xml>
39bac90c773d Uploaded
iuc
parents:
diff changeset
6 <xml name="stdio">
39bac90c773d Uploaded
iuc
parents:
diff changeset
7 <stdio>
39bac90c773d Uploaded
iuc
parents:
diff changeset
8 <exit_code range=":-1" level="fatal" description="Error: Cannot open file" />
39bac90c773d Uploaded
iuc
parents:
diff changeset
9 <exit_code range="1:" level="fatal" description="Error" />
39bac90c773d Uploaded
iuc
parents:
diff changeset
10 </stdio>
39bac90c773d Uploaded
iuc
parents:
diff changeset
11 </xml>
7
aaa749ea91a2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit d12a2e9dd273b4c23db48bbb747f32700887710e
iuc
parents: 2
diff changeset
12 <xml name="version_command">
8
1501e66908de planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 00efb7078cfb3664ef048925d0a6b02d8578c27d
iuc
parents: 7
diff changeset
13 <version_command><![CDATA[
11
81fba81425a4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 5c6d595ecbf2e4e39c25662a165c9e475e01ecd1
iuc
parents: 8
diff changeset
14 snpEff -version
8
1501e66908de planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 00efb7078cfb3664ef048925d0a6b02d8578c27d
iuc
parents: 7
diff changeset
15 ]]></version_command>
7
aaa749ea91a2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit d12a2e9dd273b4c23db48bbb747f32700887710e
iuc
parents: 2
diff changeset
16 </xml>
31
b7029a54f73e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 4cc10cfe702828a91ecf8bb58d3f84a36b0578f7
iuc
parents: 29
diff changeset
17 <token name="@WRAPPER_VERSION@">0</token>
b7029a54f73e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 4cc10cfe702828a91ecf8bb58d3f84a36b0578f7
iuc
parents: 29
diff changeset
18 <token name="@SNPEFF_VERSION@">5.2</token>
21
9939612ba3cf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 5ab504d384299d8c2ed496650f1f9e4a887cd102
iuc
parents: 19
diff changeset
19 <token name="@JAVA_OPTIONS@">-Xmx\${GALAXY_MEMORY_MB:-8192}m</token>
29
030fe29d4c47 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit a4c17efb8ec4b3a315766f5b5602effa275fade3
iuc
parents: 28
diff changeset
20 <xml name="ref_select">
030fe29d4c47 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit a4c17efb8ec4b3a315766f5b5602effa275fade3
iuc
parents: 28
diff changeset
21 <conditional name="reference_source">
030fe29d4c47 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit a4c17efb8ec4b3a315766f5b5602effa275fade3
iuc
parents: 28
diff changeset
22 <param name="reference_source_selector" type="select" label="Choose the source for the reference genome">
030fe29d4c47 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit a4c17efb8ec4b3a315766f5b5602effa275fade3
iuc
parents: 28
diff changeset
23 <option value="cached">Locally cached</option>
030fe29d4c47 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit a4c17efb8ec4b3a315766f5b5602effa275fade3
iuc
parents: 28
diff changeset
24 <option value="history">History</option>
030fe29d4c47 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit a4c17efb8ec4b3a315766f5b5602effa275fade3
iuc
parents: 28
diff changeset
25 </param>
030fe29d4c47 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit a4c17efb8ec4b3a315766f5b5602effa275fade3
iuc
parents: 28
diff changeset
26 <when value="cached">
030fe29d4c47 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit a4c17efb8ec4b3a315766f5b5602effa275fade3
iuc
parents: 28
diff changeset
27 <param name="ref_file" type="select" label="Select reference genome">
030fe29d4c47 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit a4c17efb8ec4b3a315766f5b5602effa275fade3
iuc
parents: 28
diff changeset
28 <options from_data_table="fasta_indexes"/>
030fe29d4c47 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit a4c17efb8ec4b3a315766f5b5602effa275fade3
iuc
parents: 28
diff changeset
29 </param>
030fe29d4c47 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit a4c17efb8ec4b3a315766f5b5602effa275fade3
iuc
parents: 28
diff changeset
30 </when>
030fe29d4c47 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit a4c17efb8ec4b3a315766f5b5602effa275fade3
iuc
parents: 28
diff changeset
31 <when value="history">
030fe29d4c47 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit a4c17efb8ec4b3a315766f5b5602effa275fade3
iuc
parents: 28
diff changeset
32 <param name="input_fasta" type="data" format="fasta,fasta.gz" label="Genome in FASTA format" help="This dataset is required for generating SnpEff database. See help section below."/>
030fe29d4c47 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit a4c17efb8ec4b3a315766f5b5602effa275fade3
iuc
parents: 28
diff changeset
33 </when>
030fe29d4c47 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit a4c17efb8ec4b3a315766f5b5602effa275fade3
iuc
parents: 28
diff changeset
34 </conditional>
030fe29d4c47 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit a4c17efb8ec4b3a315766f5b5602effa275fade3
iuc
parents: 28
diff changeset
35 </xml>
21
9939612ba3cf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 5ab504d384299d8c2ed496650f1f9e4a887cd102
iuc
parents: 19
diff changeset
36 <token name="@EXTERNAL_DOCUMENTATION@">
14
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
37
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
38
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
39 -------
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
40
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
41 To learn more about snpEff read its manual at http://snpeff.sourceforge.net/SnpEff_manual.html
2
114f423f99c0 Uploaded
iuc
parents: 0
diff changeset
42 </token>
21
9939612ba3cf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 5ab504d384299d8c2ed496650f1f9e4a887cd102
iuc
parents: 19
diff changeset
43 <token name="@SNPEFF_IN_GALAXY_INFO@">
14
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
44
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
45 -------
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
46
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
47 .. class:: warningmark
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
48
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
49 **Using SnpEff in Galaxy: A few points to remember**
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
50
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
51 SnpEff relies on specially formatted databases to generate annotations. It will not work without them. There are several ways in which these databases can be obtained.
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
52
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
53 **Pre-cached databases**
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
54
28
b1b327f475ac "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit e4366b6a23223f84039a0590cf0d7079b83d8f84"
iuc
parents: 27
diff changeset
55 Many standard (e.g., human, mouse, *Drosophila*) databases are likely pre-cached within a given Galaxy instance. You should be able to see them listed in **Genome** drop-down of **SnpEff eff** tool.
14
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
56
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
57 In you *do not see them* keep reading...
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
58
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
59 **Download pre-built databases**
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
60
31
b7029a54f73e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 4cc10cfe702828a91ecf8bb58d3f84a36b0578f7
iuc
parents: 29
diff changeset
61 SnpEff project generates large numbers of pre-build databases. To obtain and use them follow these steps:
14
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
62
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
63 #. Use **SnpEff databases** tool to generate a list of existing databases. Note the name of the database you need.
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
64 #. Use **SnpEff download** tool to download the database.
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
65 #. Finally, use **SnpEff eff** by choosing the downloaded database from the history using *Downloaded snpEff database in your history* option of the **Genome source** parameter.
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
66
16
7c4ede6d88a2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit a69e15a4016b3088ec937d6f2349be091c6b1b71
iuc
parents: 14
diff changeset
67 Alternatively, you can specify the name of the database directly in **SnpEff eff** using the *Download on demand* option (again, **Genome source** parameter). In this case snpEff will download the database before performing annotation.
14
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
68
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
69 **Create your own database**
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
70
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
71 In cases when you are dealing with bacterial or viral (or, frankly, any other) genomes it may be easier to create database yourself. For this you need:
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
72
19
718842784732 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 999eca8a05f17ae567f99b8ca3394f2105491173
iuc
parents: 16
diff changeset
73 #. Download Genbank record corresponding to your genome of interest from NCBI or use annotations in GFF format accompanied by the corresponding genome in FASTA format.
16
7c4ede6d88a2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit a69e15a4016b3088ec937d6f2349be091c6b1b71
iuc
parents: 14
diff changeset
74 #. Use **SnpEff build** to create the database.
14
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
75 #. Use the database in **SnpEff eff** (using *Custom* option for **Genome source** parameter).
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
76
19
718842784732 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 999eca8a05f17ae567f99b8ca3394f2105491173
iuc
parents: 16
diff changeset
77 Creating custom database has one major advantage. It guaranteess that you will not have any issues related to reference sequence naming -- the most common source of SnpEff errors.
14
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
78
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
79 </token>
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
80
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
81
a7c106b938dd planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 13
diff changeset
82
0
39bac90c773d Uploaded
iuc
parents:
diff changeset
83 <xml name="citations">
39bac90c773d Uploaded
iuc
parents:
diff changeset
84 <citations>
39bac90c773d Uploaded
iuc
parents:
diff changeset
85 <citation type="doi">10.4161/fly.19695</citation>
39bac90c773d Uploaded
iuc
parents:
diff changeset
86 <yield />
39bac90c773d Uploaded
iuc
parents:
diff changeset
87 </citations>
39bac90c773d Uploaded
iuc
parents:
diff changeset
88 </xml>
16
7c4ede6d88a2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit a69e15a4016b3088ec937d6f2349be091c6b1b71
iuc
parents: 14
diff changeset
89 </macros>