Mercurial > repos > iuc > pangolin
comparison pangolin.xml @ 28:9d61d3fa046c draft
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/pangolin commit f93f921e3c2d0002ff0c152d90b9221533ad22e9
author | iuc |
---|---|
date | Tue, 11 Jul 2023 22:32:30 +0000 |
parents | 03ed9524dcd1 |
children | 2f1019071464 |
comparison
equal
deleted
inserted
replaced
27:03ed9524dcd1 | 28:9d61d3fa046c |
---|---|
1 <tool id="pangolin" name="Pangolin" version="@TOOL_VERSION@+galaxy0" profile="20.01"> | 1 <tool id="pangolin" name="Pangolin" version="@TOOL_VERSION@+galaxy0" profile="20.01"> |
2 <description>Phylogenetic Assignment of Outbreak Lineages</description> | 2 <description>Phylogenetic Assignment of Outbreak Lineages</description> |
3 <macros> | 3 <macros> |
4 <token name="@TOOL_VERSION@">4.2</token> | 4 <token name="@TOOL_VERSION@">4.3</token> |
5 <token name="@PANGOLIN_DATA_VERSION@">1.17</token> | 5 <token name="@PANGOLIN_DATA_VERSION@">1.21</token> |
6 <token name="@CONSTELLATIONS_VERSION@">0.1.10</token> | 6 <token name="@CONSTELLATIONS_VERSION@">0.1.12</token> |
7 <token name="@MIN_COMPATIBLE_PANGOLIN_DATA_FORMAT@">4</token> | 7 <!-- a regex describing the pangolin-data versions that this wrapper version |
8 is backwards-compatible with; can be used with the min_pangolin_version | |
9 column of the pangolin_data and pangolin_assignment data table to offer | |
10 only compatible versions of that data. --> | |
11 <token name="@MIN_COMPATIBLE_PANGOLIN_DATA_FORMAT@"><![CDATA[^4$|^4\.3$]]></token> | |
12 <!-- pangolin-data versions >=1.20 do not contain pangoLEARN models anymore. | |
13 This version of pangolin still supports pangolearn analysis mode, but only when using | |
14 older versions of pangolin-data. --> | |
15 <token name="@MIN_COMPATIBLE_PANGOLIN_DATA_FORMAT_FOR_PANGOLEARN@">4></token> | |
8 <!-- a regex describing the scorpio versions that this wrapper version | 16 <!-- a regex describing the scorpio versions that this wrapper version |
9 is backwards-compatible with; can be used with the min_scorpio_version | 17 is backwards-compatible with; can be used with the min_scorpio_version |
10 column of the constellations data table to offer only compatible | 18 column of the pangolin_constellations data table to offer only compatible |
11 versions of constellations data. --> | 19 versions of constellations data. --> |
12 <token name="@COMPATIBLE_SCORPIO_DATA_FORMAT@"><![CDATA[(^0\.[1-3]$|^0\.[0-2]\.\d+$|^0\.3\.\d$|^0\.3\.1[0-7]$|^0$)]]></token> | 20 <token name="@COMPATIBLE_SCORPIO_DATA_FORMAT@"><![CDATA[(^0\.[1-3]$|^0\.[0-2]\.\d+$|^0\.3\.\d$|^0\.3\.1[0-7]$|^0$)]]></token> |
13 <xml name="usher_download_option"> | |
14 <when value="download"> | |
15 <param argument="--use-assignment-cache" type="boolean" truevalue="--use-assignment-cache" falsevalue="" label="Download and use also latest UShER assignment cache?" | |
16 help="Get the latest UShER assignment cache from the pangolin-assignment online repository and use it to speed up UShER lineage assignment. Note: Downloading the cached assignments will only pay off for large numbers of input samples." /> | |
17 </when> | |
18 </xml> | |
19 <xml name="cached_usher_assignment_cache"> | 21 <xml name="cached_usher_assignment_cache"> |
20 <param name="assignment_cache_release" type="select" optional="true" label="Use corresponding UShER assignment cache?" | 22 <param name="assignment_cache_release" type="select" optional="true" label="Use corresponding UShER assignment cache?" |
21 help="If the server offers a copy of the UShER assignment cache along with the specified version of pangolin-data, you can select it here to speed up UShER lineage assignment. If no suitable assignment cache is available, it is perfectly fine to proceed without one, and the performance difference will only become obvious with very large numbers of samples."> | 23 help="If the server offers a copy of the UShER assignment cache along with the specified version of pangolin-data, you can select it here to speed up UShER lineage assignment. If no suitable assignment cache is available, it is perfectly fine to proceed without one, and the performance difference will only become obvious with very large numbers of samples."> |
22 <options from_data_table="pangolin_assignment"> | 24 <options from_data_table="pangolin_assignment"> |
23 <column name="value" index="0" /> | 25 <column name="value" index="0" /> |
24 <column name="description" index="1" /> | 26 <column name="description" index="1" /> |
25 <column name="path" index="4" /> | 27 <column name="path" index="4" /> |
26 <filter type="static_value" column="2" value="@MIN_COMPATIBLE_PANGOLIN_DATA_FORMAT@" /> | 28 <filter type="regexp" column="2" value="@MIN_COMPATIBLE_PANGOLIN_DATA_FORMAT@" /> |
27 <filter type="param_value" ref="release" column="0" /> | 29 <filter type="param_value" ref="release" column="0" /> |
28 </options> | 30 </options> |
29 </param> | 31 </param> |
30 </xml> | |
31 <xml name="cached_pangolin_data"> | |
32 <when value="cached"> | |
33 <param name="release" label="Cached release of pangolin-data" type="select"> | |
34 <options from_data_table="pangolin_data"> | |
35 <column name="value" index="0" /> | |
36 <column name="description" index="1" /> | |
37 <column name="date" index="3" /> | |
38 <column name="path" index="4" /> | |
39 <filter type="sort_by" column="3" /> | |
40 <filter type="static_value" column="2" value="@MIN_COMPATIBLE_PANGOLIN_DATA_FORMAT@" /> | |
41 <validator type="no_options" message="No cached constellations release available" /> | |
42 </options> | |
43 </param> | |
44 <yield /> | |
45 </when> | |
46 </xml> | |
47 <xml name="pangolin_data_sources"> | |
48 <conditional name="pangolin_data"> | |
49 <param name="source" type="select" label="Version of pangolin-data to use"> | |
50 <option value="default">Use pangolin-data version (v@PANGOLIN_DATA_VERSION@) shipped with this version of the tool</option> | |
51 <option value="cached">Use specific pangolin-data version cached on this Galaxy server</option> | |
52 <option value="download">Download latest available pangolin-data version from web</option> | |
53 </param> | |
54 <when value="default" /> | |
55 <yield /> | |
56 </conditional> | |
57 </xml> | 32 </xml> |
58 </macros> | 33 </macros> |
59 <requirements> | 34 <requirements> |
60 <requirement type="package" version="@TOOL_VERSION@">pangolin</requirement> | 35 <requirement type="package" version="@TOOL_VERSION@">pangolin</requirement> |
61 <!-- Pin also the versions of all core dependencies - the ones | 36 <!-- Pin also the versions of all core dependencies - the ones |
72 when updating the wrapper for other reasons. --> | 47 when updating the wrapper for other reasons. --> |
73 <requirement type="package" version="0.3.17">scorpio</requirement> | 48 <requirement type="package" version="0.3.17">scorpio</requirement> |
74 <requirement type="package" version="@PANGOLIN_DATA_VERSION@">pangolin-data</requirement> | 49 <requirement type="package" version="@PANGOLIN_DATA_VERSION@">pangolin-data</requirement> |
75 <requirement type="package" version="@CONSTELLATIONS_VERSION@">constellations</requirement> | 50 <requirement type="package" version="@CONSTELLATIONS_VERSION@">constellations</requirement> |
76 <requirement type="package" version="0.6.2">usher</requirement> | 51 <requirement type="package" version="0.6.2">usher</requirement> |
77 <requirement type="package" version="1.1.0">gofasta</requirement> | 52 <requirement type="package" version="1.2.0">gofasta</requirement> |
78 <requirement type="package" version="426">ucsc-fatovcf</requirement> | 53 <requirement type="package" version="448">ucsc-fatovcf</requirement> |
79 <requirement type="package" version="2.24">minimap2</requirement> | 54 <requirement type="package" version="2.26">minimap2</requirement> |
80 <!-- wrapper-specific requirements to turn pangolin's native | 55 <!-- wrapper-specific requirements to turn pangolin's native |
81 comma-separated output into tab-separated one and to truncate | 56 comma-separated output into tab-separated one and to truncate |
82 pangolin's all-versions output. --> | 57 pangolin's all-versions output. --> |
83 <requirement type="package" version="0.25.0">csvtk</requirement> | 58 <requirement type="package" version="0.26.0">csvtk</requirement> |
84 <requirement type="package" version="3.4">grep</requirement> | 59 <requirement type="package" version="3.11">grep</requirement> |
85 </requirements> | 60 </requirements> |
86 <version_command><![CDATA[pangolin --version]]></version_command> | 61 <version_command><![CDATA[pangolin --version]]></version_command> |
87 <command detect_errors="exit_code"><![CDATA[ | 62 <command detect_errors="exit_code"><![CDATA[ |
88 ## Prepare a pangolin datadir if required: | 63 ## Prepare a pangolin datadir if required: |
89 #if str($engine.pangolin_data.source) != 'default' or str($constellations.source) != 'default': | 64 #if str($engine.pangolin_data.source) != 'default' or str($constellations.source) != 'default': |
177 --use-assignment-cache | 152 --use-assignment-cache |
178 #end if | 153 #end if |
179 #end if | 154 #end if |
180 #end if | 155 #end if |
181 #if $alignment: | 156 #if $alignment: |
182 $alignment --alignment-file '$align1' | 157 $alignment --alignment-file aln.fa |
183 #end if | 158 #end if |
184 --outfile report.csv | 159 --outfile report.csv |
185 --max-ambig $max_ambig | 160 --max-ambig $max_ambig |
186 --min-length $min_length | 161 --min-length $min_length |
187 $expanded_lineage | 162 $expanded_lineage |
199 help="The analysis engine to use for lineage assignment. Note: In this version, UShER mode is implemented through the usher-sampled algorithm of UShER. If you prefer to run the original usher algorithm, please use version 4.1.3 of the tool."> | 174 help="The analysis engine to use for lineage assignment. Note: In this version, UShER mode is implemented through the usher-sampled algorithm of UShER. If you prefer to run the original usher algorithm, please use version 4.1.3 of the tool."> |
200 <option value="usher">UShER</option> | 175 <option value="usher">UShER</option> |
201 <option value="pangolearn">pangoLEARN</option> | 176 <option value="pangolearn">pangoLEARN</option> |
202 </param> | 177 </param> |
203 <when value="usher"> | 178 <when value="usher"> |
204 <expand macro="pangolin_data_sources"> | 179 <conditional name="pangolin_data"> |
205 <expand macro="cached_pangolin_data"> | 180 <param name="source" type="select" label="Version of pangolin-data to use"> |
181 <option value="default">Use pangolin-data version (v@PANGOLIN_DATA_VERSION@) shipped with this version of the tool</option> | |
182 <option value="cached">Use specific pangolin-data version cached on this Galaxy server</option> | |
183 <option value="download">Download latest available pangolin-data version from web</option> | |
184 </param> | |
185 <when value="default" /> | |
186 <when value="cached"> | |
187 <param name="release" label="Cached release of pangolin-data" type="select"> | |
188 <options from_data_table="pangolin_data"> | |
189 <column name="value" index="0" /> | |
190 <column name="description" index="1" /> | |
191 <column name="date" index="3" /> | |
192 <column name="path" index="4" /> | |
193 <filter type="sort_by" column="3" /> | |
194 <filter type="regexp" column="2" value="@MIN_COMPATIBLE_PANGOLIN_DATA_FORMAT@" /> | |
195 <validator type="no_options" message="No compatible cached pangolin-data release available" /> | |
196 </options> | |
197 </param> | |
206 <expand macro="cached_usher_assignment_cache" /> | 198 <expand macro="cached_usher_assignment_cache" /> |
207 </expand> | 199 </when> |
208 <expand macro="usher_download_option" /> | 200 <when value="download"> |
209 </expand> | 201 <param argument="--use-assignment-cache" type="boolean" truevalue="--use-assignment-cache" falsevalue="" label="Download and use also latest UShER assignment cache?" |
202 help="Get the latest UShER assignment cache from the pangolin-assignment online repository and use it to speed up UShER lineage assignment. Note: Downloading the cached assignments will only pay off for large numbers of input samples." /> | |
203 </when> | |
204 </conditional> | |
210 </when> | 205 </when> |
211 <when value="pangolearn"> | 206 <when value="pangolearn"> |
212 <expand macro="pangolin_data_sources"> | 207 <conditional name="pangolin_data"> |
213 <expand macro="cached_pangolin_data" /> | 208 <param name="source" type="select" label="Version of pangolin-data to use" |
214 <when value="download" /> | 209 help="Please note: pangoLEARN mode is considered deprecated and the underlying machine learning model has been removed from recent versions of pangolin-data. If you really still want to use this mode, you are restricted to the compatible historic pangolin-data versions cached on this Galaxy server."> |
215 </expand> | 210 <option value="cached">Use specific pangolin-data version cached on this Galaxy server</option> |
211 </param> | |
212 <when value="cached"> | |
213 <param name="release" label="Cached release of pangolin-data" type="select"> | |
214 <options from_data_table="pangolin_data"> | |
215 <column name="value" index="0" /> | |
216 <column name="description" index="1" /> | |
217 <column name="date" index="3" /> | |
218 <column name="path" index="4" /> | |
219 <filter type="sort_by" column="3" /> | |
220 <filter type="static_value" column="2" value="@MIN_COMPATIBLE_PANGOLIN_DATA_FORMAT_FOR_PANGOLEARN@" /> | |
221 <validator type="no_options" message="No compatible cached pangolin-data release available" /> | |
222 </options> | |
223 </param> | |
224 </when> | |
225 </conditional> | |
216 </when> | 226 </when> |
217 </conditional> | 227 </conditional> |
218 <conditional name="constellations"> | 228 <conditional name="constellations"> |
219 <param name="source" type="select" label="Version of constellations to use"> | 229 <param name="source" type="select" label="Version of constellations to use"> |
220 <option value="default">Use constellations version (v@CONSTELLATIONS_VERSION@) shipped with this version of the tool</option> | 230 <option value="default">Use constellations version (v@CONSTELLATIONS_VERSION@) shipped with this version of the tool</option> |
229 <column name="description" index="1" /> | 239 <column name="description" index="1" /> |
230 <column name="date" index="3" /> | 240 <column name="date" index="3" /> |
231 <column name="path" index="4" /> | 241 <column name="path" index="4" /> |
232 <filter type="sort_by" column="3" /> | 242 <filter type="sort_by" column="3" /> |
233 <filter type="regexp" column="2" value="@COMPATIBLE_SCORPIO_DATA_FORMAT@" /> | 243 <filter type="regexp" column="2" value="@COMPATIBLE_SCORPIO_DATA_FORMAT@" /> |
234 <validator type="no_options" message="No cached constellations release available" /> | 244 <validator type="no_options" message="No compatible cached constellations release available" /> |
235 </options> | 245 </options> |
236 </param> | 246 </param> |
237 </when> | 247 </when> |
238 <when value="download" /> | 248 <when value="download" /> |
239 </conditional> | 249 </conditional> |
255 <action name="column_names" type="metadata" default="taxon,lineage,conflict,ambiguity_score,scorpio_call,scorpio_support,scorpio_conflict,scorpio_notes,version,pangolin_version,scorpio_version,constellation_version,is_designated,qc_status,qc_notes,note,expanded_lineage" /> | 265 <action name="column_names" type="metadata" default="taxon,lineage,conflict,ambiguity_score,scorpio_call,scorpio_support,scorpio_conflict,scorpio_notes,version,pangolin_version,scorpio_version,constellation_version,is_designated,qc_status,qc_notes,note,expanded_lineage" /> |
256 </when> | 266 </when> |
257 </conditional> | 267 </conditional> |
258 </actions> | 268 </actions> |
259 </data> | 269 </data> |
260 <data name="align1" format="fasta" label="pangolin alignment on ${on_string}"> | 270 <data name="align1" format="fasta" from_work_dir="aln.fa" label="pangolin alignment on ${on_string}"> |
261 <filter>alignment</filter> | 271 <filter>alignment</filter> |
262 </data> | 272 </data> |
263 </outputs> | 273 </outputs> |
264 <tests> | 274 <tests> |
265 <!-- Test only the default UShER mode for now since the | 275 <!-- Test only the default UShER mode for now since the |