annotate diamand.xml @ 4:e1326442d13f draft

Uploaded
author bgruening
date Sat, 07 Feb 2015 14:49:26 -0500
parents 09a565cfc192
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
1 <tool id="bg_diamond" name="Diamond" version="0.1.6.0">
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
2 <description>alignment tool for short sequences against a protein database</description>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
3 <requirements>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
4 <requirement type="package" version="0.6.13">diamond</requirement>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
5 </requirements>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
6 <command>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
7 <![CDATA[
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
8
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
9 #if $ref_db_source.db_source == "history":
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
10 ln -s $ref_db_source.reference_database ./database.dmnd
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
11 #else:
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
12 ln -s ${ref_db_source.index.fields.db_path} ./database.dmnd
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
13 #end if
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
14
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
15 &&
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
16
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
17 diamond
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
18 $method.method_select
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
19 --threads "\${GALAXY_SLOTS:-12}"
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
20 --db ./database
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
21 --query $query
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
22 --out $blast_output
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
23 ##--sam $sam_output
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
24 --compress 0
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
25 --tmpdir ./
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
26
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
27 #if str($hit_filter.hit_filter_select) == 'max':
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
28 --max-target-seqs $hit_filter.max
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
29 #else:
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
30 --top $hit_filter.percentage
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
31 #end if
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
32
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
33 #if str($filter_score.filter_score_select) == 'evalue':
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
34 --evalue $filter_score.evalue
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
35 #else:
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
36 --evalue $filter_score.bitscore
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
37 #end if
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
38
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
39 --id $identity
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
40 $sensitive
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
41 --gapopen $method.gapopen
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
42 --gapextend $method.gapextend
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
43 --matrix $matrix
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
44 $seg
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
45 $salltitles
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
46
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
47 ]]>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
48 </command>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
49 <inputs>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
50
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
51 <param name="query" type="data" format="fasta" label="Input query file in FASTA format" />
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
52
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
53 <conditional name="ref_db_source">
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
54 <param name="db_source" type="select" label="Will you select a reference genome from your history or use a built-in index?" help="Built-ins were indexed using default options">
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
55 <option value="indexed">Use a built-in index</option>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
56 <option value="history">Use one from the history</option>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
57 </param>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
58 <when value="indexed">
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
59 <param name="index" type="select" label="Select a reference genome" help="If your genome of interest is not listed, contact your Galaxy admin">
1
fbe4eedec466 Uploaded
bgruening
parents: 0
diff changeset
60 <options from_data_table="diamond_database">
0
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
61 <column name="value" index="0"/>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
62 <column name="name" index="2"/>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
63 <column name="db_path" index="3"/>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
64 <filter type="sort_by" column="2"/>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
65 <validator type="no_options" message="No indexes are available for the selected input dataset"/>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
66 </options>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
67 </param>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
68 </when> <!-- build-in -->
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
69 <when value="history">
4
e1326442d13f Uploaded
bgruening
parents: 2
diff changeset
70 <param name="reference_database" type="data" format="diamond_database" label="Select the reference database" />
0
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
71 </when> <!-- history -->
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
72 </conditional>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
73
2
09a565cfc192 Uploaded
bgruening
parents: 1
diff changeset
74 <conditional name="method">
09a565cfc192 Uploaded
bgruening
parents: 1
diff changeset
75 <param name="method_select" type="select" label="What do you want to align" help="(--blastp/--blastx)">
09a565cfc192 Uploaded
bgruening
parents: 1
diff changeset
76 <option value="blastp">Align amino acid query sequences (blastp)</option>
09a565cfc192 Uploaded
bgruening
parents: 1
diff changeset
77 <option value="blastx">Align DNA query sequences (blastx)</option>
09a565cfc192 Uploaded
bgruening
parents: 1
diff changeset
78 </param>
09a565cfc192 Uploaded
bgruening
parents: 1
diff changeset
79 <when value="blastp">
09a565cfc192 Uploaded
bgruening
parents: 1
diff changeset
80 <param name="gapopen" type="integer" value="11" label="Gap open panalty" help="(--gapopen)" />
09a565cfc192 Uploaded
bgruening
parents: 1
diff changeset
81 <param name="gapextend" type="integer" value="1" label="Gap extend panalty" help="(--gapextend)" />
09a565cfc192 Uploaded
bgruening
parents: 1
diff changeset
82 </when>
09a565cfc192 Uploaded
bgruening
parents: 1
diff changeset
83 <when value="blastx">
09a565cfc192 Uploaded
bgruening
parents: 1
diff changeset
84 <param name="gapopen" type="integer" value="-1" label="Gap open panalty" help="(--gapopen)" />
09a565cfc192 Uploaded
bgruening
parents: 1
diff changeset
85 <param name="gapextend" type="integer" value="-1" label="Gap extend panalty" help="(--gapextend)" />
09a565cfc192 Uploaded
bgruening
parents: 1
diff changeset
86 </when>
09a565cfc192 Uploaded
bgruening
parents: 1
diff changeset
87 </conditional>
09a565cfc192 Uploaded
bgruening
parents: 1
diff changeset
88
0
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
89 <param name="matrix" type="select" label="Select scoring matrix" help="(--matrix)">
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
90 <option value="BLOSUM45">BLOSUM45</option>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
91 <option value="BLOSUM50">BLOSUM50</option>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
92 <option value="BLOSUM62" selected="True">BLOSUM62</option>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
93 <option value="BLOSUM80">BLOSUM80</option>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
94 <option value="BLOSUM90">BLOSUM90</option>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
95 <option value="PAM250">PAM250</option>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
96 <option value="PAM70">PAM70</option>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
97 <option value="PAM30">PAM30</option>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
98 </param>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
99
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
100 <conditional name="filter_score">
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
101 <param name="filter_score_select" type="select" label="Filter by score" help="(--evalue/--min-score)">
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
102 <option value="evalue">Maximum e-value to report alignments</option>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
103 <option value="bit">Minimum bit score to report alignments</option>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
104 </param>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
105 <when value="evalue">
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
106 <param name="evalue" type="float" value="0.001" label="Filter by evalue" help="(--evalue)" />
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
107 </when>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
108 <when value="bit">
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
109 <param name="bitscore" type="integer" value="0" label="Filter by bit score" help="(--min-score)" />
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
110 </when>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
111 </conditional>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
112
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
113 <conditional name="hit_filter">
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
114 <param name="hit_filter_select" type="select" label="Restrict number of hits by" help="(--max-target-seqs/--top)">
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
115 <option value="max">Maximum number of target sequences</option>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
116 <option value="percentage">Percentage of top alignment score</option>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
117 </param>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
118 <when value="max">
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
119 <param name="max" type="integer" value="25" label="How many hits?" help="(--max-target-seqs)" />
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
120 </when>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
121 <when value="percentage">
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
122 <param name="percentage" type="integer" value="0" label="How many percentage" help="(--top)" />
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
123 </when>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
124 </conditional>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
125
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
126 <param name="identity" type="integer" value="0" label="minimum identity to report an alignment" help="in percentage (--id)" />
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
127 <param name="salltitles" type="boolean" truevalue="--salltitles" falsevalue="" checked="false"
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
128 label="Print subject titles into the blast tabular format" help="(--salltitles)"/>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
129 <param name="seg" type="boolean" truevalue="--seg yes" falsevalue="--seg no" checked="true"
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
130 label="Enable SEG masking of queries" help="(--seg)"/>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
131 <param name="sensitive" type="boolean" truevalue="--sensitive" falsevalue="" checked="false"
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
132 label="Enable sensitive mode" help="(--sensitive)"/>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
133 </inputs>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
134 <outputs>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
135 <!--data format="sam" name="sam_output"/-->
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
136 <data format="tabular" name="blast_output"/>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
137 </outputs>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
138 <tests>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
139 <test>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
140 <param name="method" value="blastp"/>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
141 <param name="query" value="protein.fasta" ftype="fasta"/>
4
e1326442d13f Uploaded
bgruening
parents: 2
diff changeset
142 <param name="reference_database" value="diamond_makedb_result1.dmnd" ftype="diamond_database"/>
0
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
143 <param name="db_source" value="history"/>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
144 <output name="blast_output" file="diamond_result1.tabular" ftpye="tabular"/>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
145 </test>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
146 </tests>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
147 <help>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
148 <![CDATA[
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
149
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
150 .. class:: infomark
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
151
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
152 **What it does**
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
153
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
154 DIAMOND_ is a new alignment tool for aligning short DNA sequencing reads to a protein reference database such as NCBI-NR.
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
155 On Illumina reads of length 100-150bp, in fast mode, DIAMOND is about 20,000 times faster than BLASTX, while reporting
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
156 about 80-90% of all matches that BLASTX finds, with an e-value of at most 1e-5. In sensitive mode, DIAMOND ist about 2,500
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
157 times faster than BLASTX, finding more than 94% of all matches.
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
158
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
159 .. _DIAMOND: http://ab.inf.uni-tuebingen.de/software/diamond/
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
160
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
161
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
162 Supported values for gap open and gap extend parameters depending on the selected scoring matrix.
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
163
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
164 ======== ============================================
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
165 Matrix Supported values for (gap open)/(gap extend)
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
166 ======== ============================================
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
167 BLOSUM45 (10-13)/3; (12-16)/2; (16-19)/1
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
168 BLOSUM50 (9-13)/3; (12-16)/2; (15-19)/1
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
169 BLOSUM62 (6-11)/2; (9-13)/1
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
170 BLOSUM80 (6-9)/2; 13/2; 25/2; (9-11)/1
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
171 BLOSUM90 (6-9)/2; (9-11)/1
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
172 PAM250 (11-15)/3; (13-17)/2; (17-21)/1
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
173 PAM70 (6-8)/2; (9-11)/1
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
174 PAM30 (5-7)/2; (8-10)/1
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
175 ======== ============================================
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
176
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
177
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
178 ]]>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
179 </help>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
180 <citations>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
181 <citation type="doi">10.1038/nmeth.3176</citation>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
182 </citations>
ee4371aa0666 Uploaded
bgruening
parents:
diff changeset
183 </tool>