Mercurial > repos > iuc > snpeff

annotate snpEff_databases.xml @ 11:bfa6c1b8a03c 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 7893b133799b60e1b787262f4649d216adad1fc5
author iuc
date Tue, 27 Mar 2018 14:56:29 -0400
parents 5b4ac70948d2
children 5a29ab10dba6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
10
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
1 <tool id="snpEff_databases" name="SnpEff databases:" version="@wrapper_version@.1">
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
2 <description> list available databases</description>
1
500832f27cbc Uploaded
iuc
parents:
diff changeset
3 <macros>
500832f27cbc Uploaded
iuc
parents:
diff changeset
4 <import>snpEff_macros.xml</import>
500832f27cbc Uploaded
iuc
parents:
diff changeset
5 </macros>
10
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
6 <requirements>
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
7 <expand macro="requirement" />
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
8 </requirements>
3
b24873564cf6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 1
diff changeset
9 <expand macro="stdio" />
b24873564cf6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 1
diff changeset
10 <expand macro="version_command" />
7
7adfd0589f49 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 5c6d595ecbf2e4e39c25662a165c9e475e01ecd1
iuc
parents: 4
diff changeset
11 <command><![CDATA[
10
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
12
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
13 snpEff databases | grep -v '^---' | sed 's/^Genome/#Genome/' | sed 's/ *//g'
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
14
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
15 #if $include_pattern:
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
16 | grep '${include_pattern}'
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
17 #end if
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
18
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
19 #if $exclude_pattern:
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
20 | grep -v '${exclude_pattern}'
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
21 #end if
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
22
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
23 > '${snpeff_dbs}'
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
24
7
7adfd0589f49 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 5c6d595ecbf2e4e39c25662a165c9e475e01ecd1
iuc
parents: 4
diff changeset
25 ]]></command>
1
500832f27cbc Uploaded
iuc
parents:
diff changeset
26 <inputs>
10
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
27 <param name="include_pattern" size="40" type="text" value="" optional="True" label="List entries matching the following expression" help="Databases matching this expression will be listed. Here you can enter text or regular expression. For example, to show only mouse databases use 'Mouse'. Note that this parameter is case-sensitive.">
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
28 <sanitizer>
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
29 <valid initial="string.digits,string.letters">
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
30 <add value="^" />
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
31 </valid>
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
32 </sanitizer>
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
33 </param>
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
34 <param name="exclude_pattern" size="40" type="text" value="" optional="True" label="Do not output entries matching the following expression" help="Databases matching this expression WILL NOT BE listed. Here you can enter text or regular expression. For excample, to avoid all ENSEMBL bundles enter 'ENSEMBL'. Note that this parameter is case-sensitive.">
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
35 <sanitizer>
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
36 <valid initial="string.digits,string.letters">
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
37 <add value="^" />
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
38 </valid>
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
39 </sanitizer>
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
40 </param>
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
41
1
500832f27cbc Uploaded
iuc
parents:
diff changeset
42 </inputs>
500832f27cbc Uploaded
iuc
parents:
diff changeset
43 <outputs>
10
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
44 <data format="tabular" name="snpeff_dbs" label="${tool.name} @snpeff_version@ available databases" />
1
500832f27cbc Uploaded
iuc
parents:
diff changeset
45 </outputs>
3
b24873564cf6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 1
diff changeset
46 <tests>
b24873564cf6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 1
diff changeset
47 <test>
b24873564cf6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 1
diff changeset
48 <output name="snpeff_dbs">
b24873564cf6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 1
diff changeset
49 <assert_contents>
b24873564cf6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 1
diff changeset
50 <has_text text="ebola_zaire" />
b24873564cf6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 1
diff changeset
51 </assert_contents>
b24873564cf6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 1
diff changeset
52 </output>
b24873564cf6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 1
diff changeset
53 </test>
10
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
54 <test>
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
55 <param name="include_pattern" value="ebola"/>
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
56 <output name="snpeff_dbs">
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
57 <assert_contents>
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
58 <has_text text="ebola_zaire" />
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
59 </assert_contents>
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
60 </output>
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
61 </test>
3
b24873564cf6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 1
diff changeset
62 </tests>
b24873564cf6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 1
diff changeset
63 <help><![CDATA[
10
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
64
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
65 **What it does**
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
66
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
67 This tool downloads the master list of snpEff databases from @snpeff_database_url@. You can then look at this list and decide which database to use for your analysis. For example, if **List entries matching the following expression** parameter of this tool is set to *Mouse* the it will produce a tabular dataset with the following content::
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
68
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
69 mm10 Mouse http://downloads.sourceforge.net/project/snpeff/databases/v4_3/snpEff_v4_3_mm10.zip
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
70 mm9 Mouse http://downloads.sourceforge.net/project/snpeff/databases/v4_3/snpEff_v4_3_mm9.zip
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
71
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
72 This means that there two available snpEff databases for mouse genome versions mm9 and mm10. In order to download these databases you should use identifier from the first column (e.g., mm9 or mm10 in this case).
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
73
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
74 -------
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
75
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
76 .. class:: infomark
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
77
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
78 **The usage scenario**
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
79
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
80 There are two ways to use names of databases obtained with this tool in Galaxy's version on snpEff:
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
81
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
82 #. Use **SnpEff download** tool. It will download the database to the history and you will be able to use it in **SnpEff eff** tool using *Downloaded snpEff database in your history* option of the **Genome source** parameter.
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
83 #. Use *Download on demand* option of the **SnpEff eff** tool (again, **Genome source** parameter). In this case snpEff will download the database before performing annotation.
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
84
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
85 @snpeff_in_galaxy_info@
5b4ac70948d2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit eea43430ff90fe6b13b295f6d5efb2208401a7ef
iuc
parents: 9
diff changeset
86 @external_documentation@
7
7adfd0589f49 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 5c6d595ecbf2e4e39c25662a165c9e475e01ecd1
iuc
parents: 4
diff changeset
87 ]]></help>
3
b24873564cf6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 1
diff changeset
88 <expand macro="citations" />
1
500832f27cbc Uploaded
iuc
parents:
diff changeset
89 </tool>
500832f27cbc Uploaded
iuc
parents:
diff changeset
90