annotate diamond_makedb.xml @ 7:62c9df8382c2 draft

"planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit b2d290a8b609ebbc7f4b93716370143c41062ad4"
author bgruening
date Tue, 03 Dec 2019 17:40:05 -0500
parents 64be1ac21109
children 54f751e413f4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7
62c9df8382c2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit b2d290a8b609ebbc7f4b93716370143c41062ad4"
bgruening
parents: 6
diff changeset
1 <tool id="bg_diamond_makedb" name="Diamond makedb" version="@VERSION@" profile="19.01">
0
98037ef3d2a9 Imported from capsule None
bgruening
parents:
diff changeset
2 <description>Build database from a FASTA file</description>
1
df7738595640 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 0
diff changeset
3 <macros>
df7738595640 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 0
diff changeset
4 <import>macros.xml</import>
df7738595640 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 0
diff changeset
5 </macros>
df7738595640 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 0
diff changeset
6
df7738595640 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 0
diff changeset
7 <expand macro="requirements" />
df7738595640 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 0
diff changeset
8 <expand macro="stdio" />
df7738595640 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 0
diff changeset
9 <expand macro="version_command" />
df7738595640 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 0
diff changeset
10
0
98037ef3d2a9 Imported from capsule None
bgruening
parents:
diff changeset
11 <command>
98037ef3d2a9 Imported from capsule None
bgruening
parents:
diff changeset
12 <!-- DB has two files, *.dmnd and *.tx -->
6
64be1ac21109 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 1
diff changeset
13 <![CDATA[
1
df7738595640 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 0
diff changeset
14 diamond makedb
0
98037ef3d2a9 Imported from capsule None
bgruening
parents:
diff changeset
15 --threads "\${GALAXY_SLOTS:-12}"
1
df7738595640 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 0
diff changeset
16 --in '$infile'
0
98037ef3d2a9 Imported from capsule None
bgruening
parents:
diff changeset
17 --db ./database
6
64be1ac21109 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 1
diff changeset
18
64be1ac21109 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 1
diff changeset
19 #if str($tax_cond.tax_select) == 'yes':
64be1ac21109 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 1
diff changeset
20 --taxonmap '$tax_cond.taxonmap'
64be1ac21109 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 1
diff changeset
21 --taxonnodes '$tax_cond.taxonnodes'
64be1ac21109 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 1
diff changeset
22 #end if
64be1ac21109 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 1
diff changeset
23 ]]>
0
98037ef3d2a9 Imported from capsule None
bgruening
parents:
diff changeset
24 </command>
1
df7738595640 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 0
diff changeset
25
0
98037ef3d2a9 Imported from capsule None
bgruening
parents:
diff changeset
26 <inputs>
6
64be1ac21109 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 1
diff changeset
27 <param name="infile" type="data" format="fasta" label="Input reference file in FASTA format" />
64be1ac21109 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 1
diff changeset
28 <conditional name="tax_cond">
64be1ac21109 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 1
diff changeset
29 <param name="tax_select" type="select" label="Add taxonomic data?" help="Needs to be supplied in order to provide taxonomy features of the aligner">
64be1ac21109 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 1
diff changeset
30 <option value="yes">Yes</option>
64be1ac21109 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 1
diff changeset
31 <option value="no" selected="true">No</option>
64be1ac21109 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 1
diff changeset
32 </param>
64be1ac21109 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 1
diff changeset
33 <when value="yes">
64be1ac21109 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 1
diff changeset
34 <param argument="--taxonmap" type="data" format="tabular" label="protein accession to taxid mapping file" help="" />
64be1ac21109 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 1
diff changeset
35 <param argument="--taxonnodes" type="data" format="tabular" label="taxonomy nodes.dmp from NCBI" help="" />
64be1ac21109 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 1
diff changeset
36 </when>
64be1ac21109 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 1
diff changeset
37 <when value="no"/>
64be1ac21109 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 1
diff changeset
38 </conditional>
0
98037ef3d2a9 Imported from capsule None
bgruening
parents:
diff changeset
39 </inputs>
98037ef3d2a9 Imported from capsule None
bgruening
parents:
diff changeset
40
98037ef3d2a9 Imported from capsule None
bgruening
parents:
diff changeset
41 <outputs>
1
df7738595640 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 0
diff changeset
42 <data format="dmnd" name="outfile" from_work_dir="database.dmnd" label="${tool.name} on ${on_string}"/>
0
98037ef3d2a9 Imported from capsule None
bgruening
parents:
diff changeset
43 </outputs>
1
df7738595640 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 0
diff changeset
44
0
98037ef3d2a9 Imported from capsule None
bgruening
parents:
diff changeset
45 <tests>
98037ef3d2a9 Imported from capsule None
bgruening
parents:
diff changeset
46 <test>
1
df7738595640 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 0
diff changeset
47 <param name="infile" value="db.fasta" ftype="fasta"/>
6
64be1ac21109 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 1
diff changeset
48 <output name="outfile" value="db.dmnd" compare="sim_size" delta="2"/>
64be1ac21109 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 1
diff changeset
49 </test>
64be1ac21109 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 1
diff changeset
50 <test>
64be1ac21109 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 1
diff changeset
51 <param name="infile" value="db.fasta" ftype="fasta"/>
64be1ac21109 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 1
diff changeset
52 <conditional name="tax_cond">
64be1ac21109 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 1
diff changeset
53 <param name="tax_select" value="yes"/>
64be1ac21109 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 1
diff changeset
54 <param name="taxonmap" ftype="tabular" value="prot.accession2taxid" />
64be1ac21109 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 1
diff changeset
55 <param name="taxonnodes" ftype="tabular" value="nodes.dmp" />
64be1ac21109 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 1
diff changeset
56 </conditional>
64be1ac21109 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 1
diff changeset
57 <output name="outfile" value="db-wtax.dmnd" compare="sim_size" delta="2"/>
0
98037ef3d2a9 Imported from capsule None
bgruening
parents:
diff changeset
58 </test>
98037ef3d2a9 Imported from capsule None
bgruening
parents:
diff changeset
59 </tests>
1
df7738595640 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 0
diff changeset
60
0
98037ef3d2a9 Imported from capsule None
bgruening
parents:
diff changeset
61 <help>
98037ef3d2a9 Imported from capsule None
bgruening
parents:
diff changeset
62 <![CDATA[
98037ef3d2a9 Imported from capsule None
bgruening
parents:
diff changeset
63
98037ef3d2a9 Imported from capsule None
bgruening
parents:
diff changeset
64 .. class:: infomark
98037ef3d2a9 Imported from capsule None
bgruening
parents:
diff changeset
65
98037ef3d2a9 Imported from capsule None
bgruening
parents:
diff changeset
66 **What it does**
98037ef3d2a9 Imported from capsule None
bgruening
parents:
diff changeset
67
98037ef3d2a9 Imported from capsule None
bgruening
parents:
diff changeset
68 DIAMOND_ is a new alignment tool for aligning short DNA sequencing reads to a protein reference database such as NCBI-NR.
98037ef3d2a9 Imported from capsule None
bgruening
parents:
diff changeset
69 On Illumina reads of length 100-150bp, in fast mode, DIAMOND is about 20,000 times faster than BLASTX, while reporting
1
df7738595640 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 0
diff changeset
70 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
0
98037ef3d2a9 Imported from capsule None
bgruening
parents:
diff changeset
71 times faster than BLASTX, finding more than 94% of all matches.
98037ef3d2a9 Imported from capsule None
bgruening
parents:
diff changeset
72
98037ef3d2a9 Imported from capsule None
bgruening
parents:
diff changeset
73 .. _DIAMOND: http://ab.inf.uni-tuebingen.de/software/diamond/
98037ef3d2a9 Imported from capsule None
bgruening
parents:
diff changeset
74
98037ef3d2a9 Imported from capsule None
bgruening
parents:
diff changeset
75
7
62c9df8382c2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit b2d290a8b609ebbc7f4b93716370143c41062ad4"
bgruening
parents: 6
diff changeset
76 - 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.gz
6
64be1ac21109 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit 2f6d48e1d2161d03411d9fbb4fc3d16f0fa3d2e1
bgruening
parents: 1
diff changeset
77
7
62c9df8382c2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit b2d290a8b609ebbc7f4b93716370143c41062ad4"
bgruening
parents: 6
diff changeset
78 - 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
0
98037ef3d2a9 Imported from capsule None
bgruening
parents:
diff changeset
79 ]]>
98037ef3d2a9 Imported from capsule None
bgruening
parents:
diff changeset
80 </help>
1
df7738595640 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 0
diff changeset
81
df7738595640 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/diamond commit cc80b878817d052398db16574917900ebe15292e
bgruening
parents: 0
diff changeset
82 <expand macro="citations" />
0
98037ef3d2a9 Imported from capsule None
bgruening
parents:
diff changeset
83 </tool>