Mercurial > repos > iuc > autobigs

annotate autobigs-cli.xml @ 0:a5231f824c47 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/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
author iuc
date Fri, 28 Feb 2025 17:59:00 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
1 <tool id="autobigs-cli" name="autoBIGS.cli" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="21.05">
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
2 <description>Automated MLST typing</description>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
3 <macros>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
4 <import>macros.xml</import>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
5 <token name="@TOOL_VERSION@">0.6.2</token>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
6 <token name="@VERSION_SUFFIX@">0</token>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
7 <expand macro="bio_tools"/>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
8 </macros>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
9
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
10 <requirements>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
11 <requirement type="package" version="@TOOL_VERSION@">autobigs-cli</requirement>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
12 </requirements>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
13
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
14 <command detect_errors="exit_code"><![CDATA[
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
15 #if $mode.operation == "info":
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
16 autoBIGS info --retrieve-bigsdb-schemes '$database_origin.bigsdb' --csv '$info_schemes_out'
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
17 #else if $mode.operation == "st":
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
18 autoBIGS st --scheme-name '$mode.scheme' '$fasta' '$database_origin.bigsdb' '$mlst_profiles_output'
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
19 #end if
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
20 ]]></command>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
21 <inputs>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
22 <conditional name="database_origin">
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
23 <param name="origin_select" label="Database Origin" type="select" help="The origin of the database to be accessed" optional="false">
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
24 <option value="pubmlst" selected="true">PubMLST</option>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
25 <option value="institutpasteur">Institut Pasteur</option>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
26 </param>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
27 <when value="pubmlst">
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
28 <param name="bigsdb" label="PubMLST Database" type="select" help="Select from a list of sequence definition databases hosted by pubMLST." optional="false">
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
29 <options from_url="https://rest.pubmlst.org/db" request_method="GET">
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
30 <postprocess_expression type="ecma5.1"><![CDATA[${
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
31 let options = []
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
32 for (let resourceGroup of inputs) {
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
33 for (let database of resourceGroup.databases) {
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
34 if (database.name.endsWith("seqdef")) {
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
35 options.push([database.description, database.name])
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
36 }
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
37 }
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
38 }
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
39 return options
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
40 }]]></postprocess_expression>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
41 </options>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
42 </param>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
43 </when>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
44 <when value="institutpasteur">
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
45 <param name="bigsdb" label="PubMLST Database" type="select" help="Select from a list of sequence definition databases hosted by Institut Pasteur." optional="false">
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
46 <options from_url="https://bigsdb.pasteur.fr/api/db" request_method="GET">
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
47 <postprocess_expression type="ecma5.1"><![CDATA[${
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
48 let options = []
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
49 for (let resourceGroup of inputs) {
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
50 for (let database of resourceGroup.databases) {
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
51 if (database.name.endsWith("seqdef")) {
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
52 options.push([database.description, database.name])
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
53 }
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
54 }
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
55 }
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
56 return options
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
57 }]]></postprocess_expression>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
58 </options>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
59 </param>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
60 </when>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
61 </conditional>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
62 <conditional name="mode">
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
63 <param name="operation" label="Operation" type="select" help="The operational mode of the tool.">
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
64 <option value="st" selected="true">Perform sequence typing</option>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
65 <option value="info">Retrieve available schemes for database</option>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
66 </param>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
67 <when value="st">
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
68 <param name="fasta" argument="fastas" label="FASTA file" type="data" format="fasta" multiple="true" help="The FASTA(s) file to perform sequence typing on."/>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
69 <param name="scheme" argument="--scheme-name" label="BIGSdb SeqDef scheme name" type="text" optional="false" value="MLST" help="The name of the scheme to be used. Defaults to MLST. See help for more information."/>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
70 </when>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
71 <when value="info">
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
72 </when>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
73 </conditional>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
74 </inputs>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
75 <outputs>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
76 <data name="mlst_profiles_output" label="${tool.name} on ${on_string}" format="csv">
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
77 <filter>mode['operation'] == 'st'</filter>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
78 </data>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
79 <data name="info_schemes_out" label="${tool.name} supported Schemes" format="csv">
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
80 <filter>mode['operation'] == 'info'</filter>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
81 </data>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
82 </outputs>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
83 <tests>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
84 <test expect_num_outputs="1">
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
85 <param name="origin_select" value="institutpasteur"/>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
86 <param name="bigsdb" value="pubmlst_bordetella_seqdef" />
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
87 <param name="operation" value="st" />
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
88 <param name="fasta" value="tohama_I_bpertussis_minimized_features.fasta" />
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
89 <param name="scheme" value="MLST" />
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
90 <output name="mlst_profiles_output" file="tohama_I_bpertussis_minimized_features_typed.csv" ftype="csv" />
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
91 </test>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
92 <test expect_num_outputs="1">
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
93 <param name="origin_select" value="institutpasteur"/>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
94 <param name="bigsdb" value="pubmlst_bordetella_seqdef" />
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
95 <param name="operation" value="st" />
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
96 <param name="fasta" value="B3921_bpertussis_minimized_features.fasta" />
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
97 <param name="scheme" value="MLST" />
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
98 <output name="mlst_profiles_output" file="B3921_bpertussis_minimized_features_typed.csv" ftype="csv" />
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
99 </test>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
100 <test expect_num_outputs="1">
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
101 <param name="origin_select" value="institutpasteur"/>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
102 <param name="bigsdb" value="pubmlst_bordetella_seqdef" />
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
103 <param name="operation" value="st" />
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
104 <param name="fasta" value="B3913_bpertussis_minimized_features.fasta" />
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
105 <param name="scheme" value="MLST" />
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
106 <output name="mlst_profiles_output" file="B3913_bpertussis_minimized_features_typed.csv" ftype="csv" />
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
107 </test>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
108 <test expect_num_outputs="1">
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
109 <param name="origin_select" value="institutpasteur"/>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
110 <param name="bigsdb" value="pubmlst_bordetella_seqdef" />
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
111 <param name="operation" value="st" />
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
112 <param name="fasta" value="tohama_I_bpertussis_minimized_features.fasta,B3913_bpertussis_minimized_features.fasta,B3921_bpertussis_minimized_features.fasta" />
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
113 <param name="scheme" value="MLST" />
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
114 <output name="mlst_profiles_output">
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
115 <assert_contents>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
116 <has_n_lines n="4"/>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
117 <has_text text="id,st,clonal-complex,adk,fumC,glyA,icd,pepA,pgm,tyrB"/>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
118 </assert_contents>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
119 </output>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
120 </test>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
121 <test expect_num_outputs="1">
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
122 <param name="origin_select" value="institutpasteur"/>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
123 <param name="bigsdb" value="pubmlst_bordetella_seqdef" />
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
124 <param name="operation" value="info" />
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
125 <output name="info_schemes_out">
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
126 <assert_contents>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
127 <has_text text="Name,ID"/>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
128 <has_text text="MLST,3"/>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
129 </assert_contents>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
130 </output>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
131 </test>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
132 </tests>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
133 <help><![CDATA[
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
134 What is autoBIGS
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
135 ================
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
136 autoBIGS is a tool to help automatically performes multi-locus sequence typing (MLST) on given data by performing calls to necessary web BIGS database web APIs.
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
137
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
138 Support for typing schemes other than MLST
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
139 ==========================================
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
140 AutoBIGS is capable of performing typing for any available schemes given a database. To retrieve a list of available schemes in the form of a spreadsheet (CSV), under operation, select "retrieve available schemes for database" and run the tool.
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
141
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
142 Performing Sequence Typing
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
143 ==========================
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
144 Simply select "Perform Sequence Typing" for the "Operation" and select your FASTA files. Then, enter your SeqDef Database name (see "Obtaining Database Name and Schema ID" above) and schema ID.
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
145
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
146 Special behaviour for FASTAs with multiple sequences
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
147 ====================================================
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
148 AutoBIGS will treat multiple sequences in the same FASTA file as part of the same sample. This will result in a fasta with multiple sequences within the same row with the final sequence type being retrieved from the resulting alleles of the individual sequences within the FASTA. This is helpful if the input FASTA was obtained from a targetted form of sequencing for the specific needed regions (e.g., Sanger sequencing of 7 house keeping genes), rather than a whole genome sequence. If your data is a whole genome sequence (WGS) of the entire genome or similar, each WGS should have it's own FASTA.
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
149
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
150 In the case all sequences in a given FASTA have the same ID, autoBIGS will not repeat these names in the output row.
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
151
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
152 More Information
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
153 ================
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
154 For more information on the tool being wrapped itself, please see the `autoBIGS.cli Github repository`_. Issues, bugs, and feature requests for the tool itself should be submitted to the `autoBIGS.cli issues`_. If the issue/bug/feature request is solely pertanent to the Galaxy wrapper, please check out the `autoBIGS.galaxy issues`_ tracker on GitHub.
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
155
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
156
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
157 .. _autoBIGS.cli GitHub repository: https://github.com/Syph-and-VPD-Lab/autoBIGS.cli
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
158 .. _autoBIGS.cli issues: https://github.com/Syph-and-VPD-Lab/autoBIGS.cli/issues
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
159 .. _autoBIGS.galaxy: https://github.com/Syph-and-VPD-Lab/autoBIGS.galaxy
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
160 .. _autoBIGS.galaxy issues: https://github.com/Syph-and-VPD-Lab/autoBIGS.galaxy/issues
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
161 ]]></help>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
162 <citations>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
163 <citation type="bibtex">
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
164 @book{Deng2025RealYHD,
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
165 title = {Syph-and-VPD-Lab/autoBIGS.cli},
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
166 url = {https://github.com/Syph-and-VPD-Lab/autoBIGS.cli},
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
167 author = {Deng, Harrison},
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
168 date = {2025-01-24},
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
169 year = {2025},
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
170 month = {1},
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
171 day = {24},
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
172 }
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
173 </citation>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
174 </citations>
a5231f824c47 planemo upload for repository https://github.com/Syph-and-VPD-Lab/autoBIGS.cli commit 06d653e04139b58b7e9ba76ae31e74a31a31a3f3
iuc
parents:
diff changeset
175 </tool>