annotate metaquantome_db.xml @ 4:a72ac2c7cc5b draft

"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit 9204193c3442e427c149b90f15fe3a56fc9802e9"
author galaxyp
date Wed, 17 Feb 2021 17:57:37 +0000
parents 85b8866f06d7
children e63db1aa82ee
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
a72ac2c7cc5b "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit 9204193c3442e427c149b90f15fe3a56fc9802e9"
galaxyp
parents: 2
diff changeset
1 <tool id="metaquantome_db" name="metaQuantome: database" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@">
0
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
2 <description>download the GO, EC, and NCBI databases</description>
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
3 <macros>
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
4 <import>macros.xml</import>
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
5 </macros>
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
6 <expand macro="requirements" />
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
7 <command detect_errors="exit_code"><![CDATA[
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
8 mkdir -p data &&
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
9 #set $database_list = str($databases).split(',')
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
10 #for $d in $database_list
2
85b8866f06d7 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit cf8aec441ba6ef62071c3cf4ac840ebc5a710aa4"
galaxyp
parents: 0
diff changeset
11 metaquantome db '$d'
0
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
12 --dir data &&
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
13 #end for
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
14 tar --create --file '$outfile' data
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
15 ]]></command>
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
16 <inputs>
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
17 <param name="databases" type="select" multiple="True" display="checkboxes"
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
18 label="Databases to Download">
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
19 <option value="ncbi" selected="true">NCBI Taxonomy Database</option>
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
20 <option value="go" selected="true">Gene Ontology Database</option>
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
21 <option value="ec" selected="true">Enzyme Commission (EC) database</option>
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
22 </param>
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
23 </inputs>
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
24 <outputs>
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
25 <data format="tar" name="outfile" label="metaquantome databases"/>
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
26 </outputs>
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
27 <tests>
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
28 <test>
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
29 <param name="databases" value="go"/>
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
30 <output name="outfile">
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
31 <assert_contents>
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
32 <has_text text="ontology: go"/>
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
33 <has_text text="ontology: go/subsets/goslim_metagenomics"/>
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
34 </assert_contents>
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
35 </output>
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
36 </test>
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
37 </tests>
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
38 <help>
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
39 <![CDATA[
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
40 metaQuantome database
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
41 =====================
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
42
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
43 metaQuantome uses freely available bioinformatic databases to expand your set of direct annotations.
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
44 For most cases, all 3 databases can be downloaded (the default).
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
45
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
46 The databases are:
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
47
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
48 1. NCBI taxonomy database. This contains a list of all currently identified taxa and the
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
49 relationships between them.
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
50
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
51 2. Gene Ontology (GO) term database. metaQuantome uses the OBO format of the database. Specifically, two
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
52 files are used: the go-basic.obo file, which is a simplified version of the GO database that is guaranteed to be acyclic,
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
53 and the metagenomics slim GO, which is a subset of the full GO that is useful for microbiome research. More details are available at
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
54 http://geneontology.org/docs/download-ontology/
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
55
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
56 3. ENZYME database with Enzyme Classification (EC) numbers. This database classifies enzymes and organizes the
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
57 relationships between them.
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
58
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
59 This module downloads the most recent releases of the specified databases and stores them in a single file, which can then
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
60 be accessed by the rest of the metaQuantome modules. For reference,
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
61 the taxonomy database is the largest (~500 Mb), while the GO and EC databases are smaller: ~34 Mb and ~10Mb, respectively.
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
62
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
63 Also, note that the databases will be stored in the history so that the date of download can be referenced later.
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
64 Thus, the databases will not be modified, except for the NCBI database, which is updated every time ``metaQuantome: expand`` is run (this
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
65 is a limitation of the Python package ete3, used within metaQuantome).
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
66
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
67 Questions, Comments, Problems, Kudos
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
68 ------------------------------------
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
69
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
70 Please file any issues at https://github.com/galaxyproteomics/tools-galaxyp/issues.
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
71 ]]></help>
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
72 <expand macro="citations" />
f1834b310c09 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/metaquantome commit d45eb2747cc58e1120b3935f10ab47c4e0f8f44a
galaxyp
parents:
diff changeset
73 </tool>