Mercurial > repos > nml > ectyper

annotate ectyper.xml @ 1:4b4a7d9f7c9e draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
author nml
date Mon, 30 Dec 2024 17:58:09 +0000
parents 954b1b1ef3fb
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
1 <tool id="ectyper" name="ectyper" version="@VERSION@+galaxy0">
0
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
2 <description>ectyper is a standalone serotyping module for Escherichia coli. It supports fasta and fastq file formats.</description>
1
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
3 <macros>
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
4 <token name="@VERSION@">2.0.0</token>
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
5 </macros>
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
6 <xrefs>
0
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
7 <xref type="bio.tools">ectyper</xref>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
8 </xrefs>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
9 <requirements>
1
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
10 <requirement type="package" version="@VERSION@">ectyper</requirement>
0
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
11 </requirements>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
12 <command detect_errors="exit_code">
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
13 <![CDATA[
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
14 #set $genomes = ''
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
15 #if hasattr($input, '__iter__')
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
16 #for $i in $input
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
17 ln -s "${i}" "${i.element_identifier}" &&
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
18 #if len($genomes) > 0
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
19 #set $genomes = $genomes + ',' + str($i.element_identifier)
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
20 #else
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
21 #set $genomes = str($i.element_identifier)
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
22 #end if
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
23 #end for
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
24 #else
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
25 ln -s "${input}" "${input.element_identifier}" &&
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
26 #set $genomes = $input.element_identifier
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
27 #end if
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
28
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
29 #if $adv_param.mash_input
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
30 ln -s "${adv_param.mash_input}" mash_sketch.msh &&
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
31 #end if
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
32
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
33
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
34 #if $adv_param.db_input
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
35 ln -s "${adv_param.db_input}" custom_db.json &&
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
36 #end if
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
37
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
38
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
39 ectyper --cores \${GALAXY_SLOTS:-4}
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
40 --input "${genomes}"
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
41 -opid '$adv_param.opid'
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
42 -opcov '$adv_param.opcov'
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
43 -hpid '$adv_param.hpid'
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
44 -hpcov '$adv_param.hpcov'
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
45
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
46 #if $adv_param.verifyEcoli
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
47 --verify
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
48 #end if
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
49
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
50 #if $adv_param.mash_input
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
51 --refseq mash_sketch.msh
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
52 #end if
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
53
1
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
54 #if $adv_param.pathotype
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
55 --pathotype
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
56 -pathpid $adv_param.pathotype_adv_param.pathpid
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
57 -pathpcov $adv_param.pathotype_adv_param.pathpcov
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
58 #end if
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
59
0
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
60 #if $adv_param.db_input
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
61 --dbpath custom_db.json
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
62 #end if
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
63
1
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
64 #if $adv_param.longreadsmode
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
65 --longreads
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
66 #end if
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
67
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
68 #if $adv_param.debugmode
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
69 --debug
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
70 #end if
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
71
0
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
72 --output '.'
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
73 ]]>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
74 </command>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
75 <inputs>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
76 <param name="input" type="data" format="fastq,fasta" label="Genome(s) input(s)" help="FASTA or FASTQ file(s)"/>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
77 <section name="adv_param" title="Advanced parameters" expanded="False">
1
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
78 <param name="opid" label="O antigen minimum %identity" type="integer" value="95" min="1" max="100"/>
0
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
79 <param name="opcov" label="O antigen minimum %coverage" type="integer" value="90" min="1" max="100"/>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
80 <param name="hpid" label="H antigen minimum %identity" type="integer" value="95" min="1" max="100"/>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
81 <param name="hpcov" label="H antigen minimum %coverage" type="integer" value="50" min="1" max="100"/>
1
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
82 <param name="verifyEcoli" type="boolean" checked="false" label="Enable E. coli species and results QC verification"/>
0
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
83 <param name="blastresults" type="boolean" checked="false" label="Include BLAST allele alignment results tab-delim file in the outputs?" />
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
84 <param name="logging" type="boolean" checked="false" label="Include log file in the run outputs?" />
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
85 <param name="mash_input" type="data" optional="true" format="binary" label="Mash genome sketches (Optional)" help="Optionally provide custom MASH genome sketch to help with species identification (otherwise default RefSeq sketch is used)"/>
1
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
86 <param name="pathotype" type="boolean" checked="true" label="Enable E.coli pathotyping and Shiga toxin (stx) subtyping (Recommended)"/>
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
87 <section name="pathotype_adv_param" title="Advanced parameters (pathoyping and shiga toxin subtyping)" expanded="False">
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
88 <param name="pathpid" label="Minimum %identity required for a pathotype/toxin database reference allele match" type="integer" value="90" min="1" max="100"/>
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
89 <param name="pathpcov" label="Minimum %coverage required for a pathotype/toxin database reference allele match" type="integer" value="50" min="1" max="100"/>
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
90 </section>
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
91 <param name="longreadsmode" type="boolean" checked="false" label="Enable long read mapping mode (Optional)" help="Enable this mode if no typing results are obtained"/>
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
92 <param name="db_input" type="data" optional="true" format="json" label="Custom database of O and H antigen alleles (Optional)" help="Optionally provide custom database of alleles in JSON format"/>
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
93 <param name="debugmode" type="boolean" checked="false" label="Enable debug mode with high log messages verbosity"/>
0
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
94 </section>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
95 </inputs>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
96 <outputs>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
97 <data name="output_result" format="tabular" from_work_dir="output.tsv" label="${tool.name} serotype report on ${input.element_identifier}"> </data>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
98 <data name="output_log" format="txt" from_work_dir="ectyper.log" label="${tool.name} log file on ${input.element_identifier}">
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
99 <filter>adv_param['logging']==True</filter>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
100 </data>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
101 <data name="output_blast" format="tabular" from_work_dir="blast_output_alleles.txt" label="${tool.name} BLAST results file on ${input.element_identifier}">
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
102 <filter>adv_param['blastresults']==True</filter>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
103 </data>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
104 </outputs>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
105 <tests>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
106 <test expect_num_outputs="1">
1
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
107 <param name="input" value="Escherichia2.fastq" ftype="fastq"/>
0
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
108 <output name="output_result" ftype="tabular" >
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
109 <assert_contents>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
110 <has_text_matching expression="O22"/>
1
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
111 <has_text text="H8"/>
0
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
112 </assert_contents>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
113 </output>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
114 </test>
1
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
115 <test expect_num_outputs="1">
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
116 <param name="input" value="Escherichia1.fasta" ftype="fasta"/>
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
117 <output name="output_result" ftype="tabular">
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
118 <assert_contents>
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
119 <has_text text="O103:H2"/>
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
120 <has_text text="EHEC-STEC"/>
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
121 <has_text text="stx1a;stx2a"/>
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
122 <has_text text="eae,ehxA,hlyE,stx1,stx2"/>
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
123 </assert_contents>
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
124 </output>
4b4a7d9f7c9e planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit 20e805e46acfc9171da5e3281f3248295b6f8018
nml
parents: 0
diff changeset
125 </test>
0
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
126 </tests>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
127
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
128 <help>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
129 **Syntax**
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
130
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
131
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
132 This tool identifies the serotype of both assembled or assembly-free Escherichia coli genome samples based on a set of the key O and H antigen determinant genes including *wzm/wzt* or *wzx/wzy* and *fliC/flkA/flmA*.
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
133 Unique to the tool, species identification module allows for non-E.coli genomes identification including other Escherichia genus species.
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
134 This version improves antigen call rates on "difficult samples" by use of an adaptive threshold. This is especially useful when antigen genes are truncated or poorly covered by raw reads.
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
135 If no antigen call is being predicted by the tool, try to lower %coverage parameter first. For more information on the new Quality Control module and running parameter details please visit https://github.com/phac-nml/ecoli_serotyping.
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
136
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
137
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
138 -----
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
139
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
140 **Input:**
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
141
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
142 Accepts a variety of inputs including both single and/or multiple FASTQ and/or FASTA file(s). Inputs might contain pure raw reads, but for more accurate results, draft assemblies are recommended.
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
143
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
144
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
145 The default MASH RefSeq genome sketch (https://gembox.cbcb.umd.edu/mash/refseq.genomes.k21s1000.msh) containing approximately 91K genomes is included and automatically updated every 6 months.
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
146
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
147
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
148
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
149 **Output:**
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
150
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
151 Tab-delimited report listing identified O and H antigens together with corresponding the highest-scoring alleles and normalized BLAST score defined as (%identity x %coverage) / 1e4.
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
152 If *verifyEcoli* parameter is enabled, final report will contain allele quality control information on results for reporting purposes. PASS (REPORTABLE) QC flag means that O and H antigen calls are of sufficient to unambiguously resolve them from all other antigens.
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
153
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
154 -----
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
155
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
156 **Parameters (Optional):**
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
157 - **Enable E. coli species verification:** for species verification in case samples are of non-E.coli origin
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
158 - **Include BLAST allele alignment results tab-delim file in the outputs?** Get reference allele sequences and detailed BLAST output
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
159 - **Include log file in the run outputs?:** Get optional logs of the ectyper run for a more detailed results assessment and troubleshooting
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
160
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
161 </help>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
162 <citations>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
163 <citation type="bibtex">
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
164 @misc{githubectyper,
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
165 author = {Laing Chad},
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
166 title = {ECtyper - serotyping module for Escherichia coli},
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
167 publisher = {GitHub},
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
168 journal = {GitHub repository},
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
169 url = {https://github.com/phac-nml/ecoli_serotyping}
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
170 }</citation>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
171 </citations>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
172 </tool>