annotate diamond_makedb.xml @ 20:0729ae1533e5 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 62db819c1db857d3fba94dc4e290ee0f50f7928d
author iuc
date Mon, 03 Feb 2025 16:00:43 +0000
parents 7ff284249149
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
20
0729ae1533e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 62db819c1db857d3fba94dc4e290ee0f50f7928d
iuc
parents: 19
diff changeset
1 <tool id="bg_diamond_makedb" name="Diamond makedb" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="23.2" license="GPL-3.0">
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>
20
0729ae1533e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 62db819c1db857d3fba94dc4e290ee0f50f7928d
iuc
parents: 19
diff changeset
6 <expand macro="requirements"/>
0729ae1533e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 62db819c1db857d3fba94dc4e290ee0f50f7928d
iuc
parents: 19
diff changeset
7 <expand macro="stdio"/>
0729ae1533e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 62db819c1db857d3fba94dc4e290ee0f50f7928d
iuc
parents: 19
diff changeset
8 <expand macro="version_command"/>
17
33d070cbe5ee "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 75abf7d4b23ed7ae8abce80609d81b20bc882863"
iuc
parents: 16
diff changeset
9 <command detect_errors="aggressive">
20
0729ae1533e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 62db819c1db857d3fba94dc4e290ee0f50f7928d
iuc
parents: 19
diff changeset
10 <!-- 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
11 <![CDATA[
10
91b7b502af17 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 5
diff changeset
12 diamond makedb
20
0729ae1533e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 62db819c1db857d3fba94dc4e290ee0f50f7928d
iuc
parents: 19
diff changeset
13 --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
14 --in '$infile'
5
47b17961c436 Uploaded
bgruening
parents:
diff changeset
15 --db ./database
15
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
16
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
17 #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
18 --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
19 --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
20 --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
21 #end if
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
22 ]]>
5
47b17961c436 Uploaded
bgruening
parents:
diff changeset
23 </command>
47b17961c436 Uploaded
bgruening
parents:
diff changeset
24 <inputs>
20
0729ae1533e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 62db819c1db857d3fba94dc4e290ee0f50f7928d
iuc
parents: 19
diff changeset
25 <param name="infile" type="data" format="fasta" label="Input reference file in FASTA format"/>
0729ae1533e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 62db819c1db857d3fba94dc4e290ee0f50f7928d
iuc
parents: 19
diff changeset
26 <conditional name="tax_cond">
0729ae1533e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 62db819c1db857d3fba94dc4e290ee0f50f7928d
iuc
parents: 19
diff changeset
27 <param name="tax_select" type="select" label="Add taxonomic data?" help="Needs to be supplied in order to provide taxonomy features of the aligner">
0729ae1533e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 62db819c1db857d3fba94dc4e290ee0f50f7928d
iuc
parents: 19
diff changeset
28 <option value="yes">Yes</option>
0729ae1533e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 62db819c1db857d3fba94dc4e290ee0f50f7928d
iuc
parents: 19
diff changeset
29 <option value="no" selected="true">No</option>
0729ae1533e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 62db819c1db857d3fba94dc4e290ee0f50f7928d
iuc
parents: 19
diff changeset
30 </param>
0729ae1533e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 62db819c1db857d3fba94dc4e290ee0f50f7928d
iuc
parents: 19
diff changeset
31 <when value="yes">
0729ae1533e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 62db819c1db857d3fba94dc4e290ee0f50f7928d
iuc
parents: 19
diff changeset
32 <param argument="--taxonmap" type="data" format="tabular" label="Protein accession to taxid mapping file" help="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. A custom file following the same format may be supplied here. Note that the first line of this file is assumed to contain headings and will be ignored"/>
0729ae1533e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 62db819c1db857d3fba94dc4e290ee0f50f7928d
iuc
parents: 19
diff changeset
33 <param argument="--taxonnodes" type="data" format="tabular" label="Taxonomy nodes.dmp from NCBI" help="This parameter is optional and needs to be supplied in order to provide taxonomy features"/>
0729ae1533e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 62db819c1db857d3fba94dc4e290ee0f50f7928d
iuc
parents: 19
diff changeset
34 <param argument="--taxonnames" type="data" format="tabular" label="Taxonomy names.dmp from NCBI" help="This parameter is optional and needs to be supplied in order to provide taxonomy features"/>
0729ae1533e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 62db819c1db857d3fba94dc4e290ee0f50f7928d
iuc
parents: 19
diff changeset
35 </when>
0729ae1533e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 62db819c1db857d3fba94dc4e290ee0f50f7928d
iuc
parents: 19
diff changeset
36 <when value="no"/>
0729ae1533e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 62db819c1db857d3fba94dc4e290ee0f50f7928d
iuc
parents: 19
diff changeset
37 </conditional>
5
47b17961c436 Uploaded
bgruening
parents:
diff changeset
38 </inputs>
47b17961c436 Uploaded
bgruening
parents:
diff changeset
39 <outputs>
10
91b7b502af17 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 5
diff changeset
40 <data format="dmnd" name="outfile" from_work_dir="database.dmnd" label="${tool.name} on ${on_string}"/>
5
47b17961c436 Uploaded
bgruening
parents:
diff changeset
41 </outputs>
47b17961c436 Uploaded
bgruening
parents:
diff changeset
42 <tests>
47b17961c436 Uploaded
bgruening
parents:
diff changeset
43 <test>
10
91b7b502af17 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 5
diff changeset
44 <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
45 <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
46 </test>
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
47 <test>
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
48 <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
49 <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
50 <param name="tax_select" value="yes"/>
20
0729ae1533e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 62db819c1db857d3fba94dc4e290ee0f50f7928d
iuc
parents: 19
diff changeset
51 <param name="taxonmap" ftype="tabular" value="prot.accession2taxid"/>
0729ae1533e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 62db819c1db857d3fba94dc4e290ee0f50f7928d
iuc
parents: 19
diff changeset
52 <param name="taxonnodes" ftype="tabular" value="nodes.dmp"/>
0729ae1533e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 62db819c1db857d3fba94dc4e290ee0f50f7928d
iuc
parents: 19
diff changeset
53 <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
54 </conditional>
409ecbc31558 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 10
diff changeset
55 <output name="outfile" value="db-wtax.dmnd" compare="sim_size" delta="2"/>
5
47b17961c436 Uploaded
bgruening
parents:
diff changeset
56 </test>
47b17961c436 Uploaded
bgruening
parents:
diff changeset
57 </tests>
47b17961c436 Uploaded
bgruening
parents:
diff changeset
58 <help>
47b17961c436 Uploaded
bgruening
parents:
diff changeset
59 <![CDATA[
47b17961c436 Uploaded
bgruening
parents:
diff changeset
60
47b17961c436 Uploaded
bgruening
parents:
diff changeset
61 .. class:: infomark
47b17961c436 Uploaded
bgruening
parents:
diff changeset
62
47b17961c436 Uploaded
bgruening
parents:
diff changeset
63 **What it does**
47b17961c436 Uploaded
bgruening
parents:
diff changeset
64
47b17961c436 Uploaded
bgruening
parents:
diff changeset
65 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
66 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
67 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
68 times faster than BLASTX, finding more than 94% of all matches.
47b17961c436 Uploaded
bgruening
parents:
diff changeset
69
47b17961c436 Uploaded
bgruening
parents:
diff changeset
70 .. _DIAMOND: http://ab.inf.uni-tuebingen.de/software/diamond/
47b17961c436 Uploaded
bgruening
parents:
diff changeset
71
47b17961c436 Uploaded
bgruening
parents:
diff changeset
72
19
7ff284249149 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit b9f434bf71431a3b9548eb17fcc2639b3b6f8b01"
iuc
parents: 18
diff changeset
73 - 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://ftp.ncbi.nlm.nih.gov/pub/taxonomy/accession2taxid/prot.accession2taxid.gz
17
33d070cbe5ee "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 75abf7d4b23ed7ae8abce80609d81b20bc882863"
iuc
parents: 16
diff changeset
74
33d070cbe5ee "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 75abf7d4b23ed7ae8abce80609d81b20bc882863"
iuc
parents: 16
diff changeset
75 - 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
76
16
fe69c39eb695 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit b2d290a8b609ebbc7f4b93716370143c41062ad4"
bgruening
parents: 15
diff changeset
77 - 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
78 ]]>
47b17961c436 Uploaded
bgruening
parents:
diff changeset
79 </help>
20
0729ae1533e5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/diamond commit 62db819c1db857d3fba94dc4e290ee0f50f7928d
iuc
parents: 19
diff changeset
80 <expand macro="citations"/>
5
47b17961c436 Uploaded
bgruening
parents:
diff changeset
81 </tool>