annotate diamond_makedb.xml @ 18:18e6fcba0646 draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 828c844036743151594e57cc19811f4c8d9179b3"
author iuc
date Sat, 27 Nov 2021 09:47:10 +0000
parents 33d070cbe5ee
children 7ff284249149
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18
18e6fcba0646 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 828c844036743151594e57cc19811f4c8d9179b3"
iuc
parents: 17
diff changeset
1 <tool id="bg_diamond_makedb" name="Diamond makedb" version="@TOOL_VERSION@" profile="19.01">
5
47b17961c436 Uploaded
bgruening
parents:
diff changeset
2 <description>Build database from a FASTA file</description>
10
91b7b502af17 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 5
diff changeset
3 <macros>
91b7b502af17 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 5
diff changeset
4 <import>macros.xml</import>
91b7b502af17 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 5
diff changeset
5 </macros>
91b7b502af17 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 5
diff changeset
6
91b7b502af17 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 5
diff changeset
7 <expand macro="requirements" />
91b7b502af17 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 5
diff changeset
8 <expand macro="stdio" />
91b7b502af17 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 5
diff changeset
9 <expand macro="version_command" />
91b7b502af17 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 5
diff changeset
10
17
33d070cbe5ee "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 75abf7d4b23ed7ae8abce80609d81b20bc882863"
iuc
parents: 16
diff changeset
11 <command detect_errors="aggressive">
5
47b17961c436 Uploaded
bgruening
parents:
diff changeset
12 <!-- DB has two files, *.dmnd and *.tx -->
15
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
13 <![CDATA[
10
91b7b502af17 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 5
diff changeset
14 diamond makedb
5
47b17961c436 Uploaded
bgruening
parents:
diff changeset
15 --threads "\${GALAXY_SLOTS:-12}"
10
91b7b502af17 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 5
diff changeset
16 --in '$infile'
5
47b17961c436 Uploaded
bgruening
parents:
diff changeset
17 --db ./database
15
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
18
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
19 #if str($tax_cond.tax_select) == 'yes':
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
20 --taxonmap '$tax_cond.taxonmap'
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
21 --taxonnodes '$tax_cond.taxonnodes'
17
33d070cbe5ee "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 75abf7d4b23ed7ae8abce80609d81b20bc882863"
iuc
parents: 16
diff changeset
22 --taxonnames '$tax_cond.taxonnames'
15
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
23 #end if
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
24 ]]>
5
47b17961c436 Uploaded
bgruening
parents:
diff changeset
25 </command>
10
91b7b502af17 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 5
diff changeset
26
5
47b17961c436 Uploaded
bgruening
parents:
diff changeset
27 <inputs>
15
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
28 <param name="infile" type="data" format="fasta" label="Input reference file in FASTA format" />
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
29 <conditional name="tax_cond">
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
30 <param name="tax_select" type="select" label="Add taxonomic data?" help="Needs to be supplied in order to provide taxonomy features of the aligner">
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
31 <option value="yes">Yes</option>
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
32 <option value="no" selected="true">No</option>
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
33 </param>
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
34 <when value="yes">
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
35 <param argument="--taxonmap" type="data" format="tabular" label="protein accession to taxid mapping file" help="" />
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
36 <param argument="--taxonnodes" type="data" format="tabular" label="taxonomy nodes.dmp from NCBI" help="" />
17
33d070cbe5ee "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 75abf7d4b23ed7ae8abce80609d81b20bc882863"
iuc
parents: 16
diff changeset
37 <param argument="--taxonnames" type="data" format="tabular" label="taxonomy names.dmp from NCBI" help="" />
15
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
38 </when>
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
39 <when value="no"/>
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
40 </conditional>
5
47b17961c436 Uploaded
bgruening
parents:
diff changeset
41 </inputs>
47b17961c436 Uploaded
bgruening
parents:
diff changeset
42
47b17961c436 Uploaded
bgruening
parents:
diff changeset
43 <outputs>
10
91b7b502af17 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 5
diff changeset
44 <data format="dmnd" name="outfile" from_work_dir="database.dmnd" label="${tool.name} on ${on_string}"/>
5
47b17961c436 Uploaded
bgruening
parents:
diff changeset
45 </outputs>
10
91b7b502af17 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 5
diff changeset
46
5
47b17961c436 Uploaded
bgruening
parents:
diff changeset
47 <tests>
47b17961c436 Uploaded
bgruening
parents:
diff changeset
48 <test>
10
91b7b502af17 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 5
diff changeset
49 <param name="infile" value="db.fasta" ftype="fasta"/>
15
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
50 <output name="outfile" value="db.dmnd" compare="sim_size" delta="2"/>
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
51 </test>
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
52 <test>
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
53 <param name="infile" value="db.fasta" ftype="fasta"/>
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
54 <conditional name="tax_cond">
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
55 <param name="tax_select" value="yes"/>
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
56 <param name="taxonmap" ftype="tabular" value="prot.accession2taxid" />
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
57 <param name="taxonnodes" ftype="tabular" value="nodes.dmp" />
17
33d070cbe5ee "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 75abf7d4b23ed7ae8abce80609d81b20bc882863"
iuc
parents: 16
diff changeset
58 <param name="taxonnames" ftype="tabular" value="names.dmp" />
15
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
59 </conditional>
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
60 <output name="outfile" value="db-wtax.dmnd" compare="sim_size" delta="2"/>
5
47b17961c436 Uploaded
bgruening
parents:
diff changeset
61 </test>
47b17961c436 Uploaded
bgruening
parents:
diff changeset
62 </tests>
10
91b7b502af17 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 5
diff changeset
63
5
47b17961c436 Uploaded
bgruening
parents:
diff changeset
64 <help>
47b17961c436 Uploaded
bgruening
parents:
diff changeset
65 <![CDATA[
47b17961c436 Uploaded
bgruening
parents:
diff changeset
66
47b17961c436 Uploaded
bgruening
parents:
diff changeset
67 .. class:: infomark
47b17961c436 Uploaded
bgruening
parents:
diff changeset
68
47b17961c436 Uploaded
bgruening
parents:
diff changeset
69 **What it does**
47b17961c436 Uploaded
bgruening
parents:
diff changeset
70
47b17961c436 Uploaded
bgruening
parents:
diff changeset
71 DIAMOND_ is a new alignment tool for aligning short DNA sequencing reads to a protein reference database such as NCBI-NR.
47b17961c436 Uploaded
bgruening
parents:
diff changeset
72 On Illumina reads of length 100-150bp, in fast mode, DIAMOND is about 20,000 times faster than BLASTX, while reporting
10
91b7b502af17 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 5
diff changeset
73 about 80-90% of all matches that BLASTX finds, with an e-value of at most 1e-5. In sensitive mode, DIAMOND is about 2,500
5
47b17961c436 Uploaded
bgruening
parents:
diff changeset
74 times faster than BLASTX, finding more than 94% of all matches.
47b17961c436 Uploaded
bgruening
parents:
diff changeset
75
47b17961c436 Uploaded
bgruening
parents:
diff changeset
76 .. _DIAMOND: http://ab.inf.uni-tuebingen.de/software/diamond/
47b17961c436 Uploaded
bgruening
parents:
diff changeset
77
47b17961c436 Uploaded
bgruening
parents:
diff changeset
78
17
33d070cbe5ee "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 75abf7d4b23ed7ae8abce80609d81b20bc882863"
iuc
parents: 16
diff changeset
79 - taxonmap: Path to mapping file that maps NCBI protein accession numbers to taxon ids (gzip compressed). This parameter is optional and needs to be supplied in order to provide taxonomy features. The file can be downloaded from NCBI: ftp.ncbi.nlm.nih.gov/pub/taxonomy/accession2taxid/prot.accession2taxid.FULL.gz
33d070cbe5ee "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 75abf7d4b23ed7ae8abce80609d81b20bc882863"
iuc
parents: 16
diff changeset
80
33d070cbe5ee "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 75abf7d4b23ed7ae8abce80609d81b20bc882863"
iuc
parents: 16
diff changeset
81 - taxonnames: Path to the names.dmp file from the NCBI taxonomy. This parameter is optional and needs to be supplied in order to provide taxonomy features. The file is contained within this archive downloadable at NCBI: ftp.ncbi.nlm.nih.gov/pub/taxonomy/taxdmp.zip
15
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
82
16
fe69c39eb695 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit b2d290a8b609ebbc7f4b93716370143c41062ad4"
bgruening
parents: 15
diff changeset
83 - taxonnodes: Path to the nodes.dmp file from the NCBI taxonomy. This parameter is optional and needs to be supplied in order to provide taxonomy features. The file is contained within this archive downloadable at NCBI: ftp.ncbi.nlm.nih.gov/pub/taxonomy/taxdmp.zip
5
47b17961c436 Uploaded
bgruening
parents:
diff changeset
84 ]]>
47b17961c436 Uploaded
bgruening
parents:
diff changeset
85 </help>
10
91b7b502af17 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 5
diff changeset
86
91b7b502af17 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 5
diff changeset
87 <expand macro="citations" />
5
47b17961c436 Uploaded
bgruening
parents:
diff changeset
88 </tool>