Mercurial > repos > nml > ectyper

annotate ectyper.xml @ 0:954b1b1ef3fb draft

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 f574c20c5f06498727d186afc4d1a92f5344eb59
author nml
date Wed, 18 Dec 2024 22:36:31 +0000
parents
children 4b4a7d9f7c9e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
1 <tool id="ectyper" name="ectyper" version="1.0.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>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
3 <xrefs>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
4 <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
5 </xrefs>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
6 <requirements>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
7 <requirement type="package" version="1.0.0">ectyper</requirement>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
8 </requirements>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
9 <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
10 <![CDATA[
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
11 #set $genomes = ''
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
12 #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
13 #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
14 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
15 #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
16 #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
17 #else
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
18 #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
19 #end if
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
20 #end for
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
21 #else
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
22 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
23 #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
24 #end if
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
25
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
26 #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
27 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
28 #end if
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
29
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
30
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
31 #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
32 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
33 #end if
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
34
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
35
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
36 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
37 --input "${genomes}"
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
38 -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
39 -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
40 -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
41 -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
42
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
43 #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
44 --verify
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
45 #end if
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
46
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
47 #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
48 --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
49 #end if
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
50
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
51 #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
52 --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
53 #end if
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
54
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
55 --output '.'
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
56 ]]>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
57 </command>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
58 <inputs>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
59 <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
60 <section name="adv_param" title="Advanced parameters" expanded="False">
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
61 <param name="opid" label="O antigen minimum %identity" 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
62 <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
63 <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
64 <param name="hpcov" label="H antigen minimum %coverage" type="integer" value="50" 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
65 <param name="verifyEcoli" type="boolean" checked="true" label="Enable E. coli species verification"/>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
66 <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
67 <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
68 <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)"/>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
69 <param name="db_input" type="data" optional="true" format="json" label="Custom database of alleles (Optional)" help="Optionally provide custom database of alleles in JSON format"/>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
70 </section>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
71 </inputs>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
72 <outputs>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
73 <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
74 <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
75 <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
76 </data>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
77 <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
78 <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
79 </data>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
80 </outputs>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
81 <tests>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
82 <test expect_num_outputs="1">
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="input" value="Escherichia2.fastq"/>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
84 <assert_stderr>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
85 <has_text text="O22"/>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
86 <has_text text="H8"/>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
87 </assert_stderr>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
88 <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
89 <assert_contents>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
90 <has_text_matching expression="O22"/>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
91 </assert_contents>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
92 </output>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
93 </test>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
94 </tests>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
95
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
96 <help>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
97 **Syntax**
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
98
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
99
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
100 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
101 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
102 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
103 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
104
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
105
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
106 -----
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
107
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
108 **Input:**
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
109
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
110 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
111
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
112
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
113 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
114
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
115
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
116
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
117 **Output:**
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
118
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
119 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
120 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
121
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
122 -----
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
123
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
124 **Parameters (Optional):**
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
125 - **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
126 - **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
127 - **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
128
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
129 </help>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
130 <citations>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
131 <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
132 @misc{githubectyper,
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
133 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
134 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
135 publisher = {GitHub},
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
136 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
137 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
138 }</citation>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
139 </citations>
954b1b1ef3fb planemo upload for repository https://github.com/phac-nml/galaxy_tools/tree/master/tools/ectyper commit f574c20c5f06498727d186afc4d1a92f5344eb59
nml
parents:
diff changeset
140 </tool>