Mercurial > repos > iuc > autobigs

comparison 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
comparison
equal deleted inserted replaced
-1:000000000000 0:a5231f824c47
1 <tool id="autobigs-cli" name="autoBIGS.cli" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="21.05">
2 <description>Automated MLST typing</description>
3 <macros>
4 <import>macros.xml</import>
5 <token name="@TOOL_VERSION@">0.6.2</token>
6 <token name="@VERSION_SUFFIX@">0</token>
7 <expand macro="bio_tools"/>
8 </macros>
9
10 <requirements>
11 <requirement type="package" version="@TOOL_VERSION@">autobigs-cli</requirement>
12 </requirements>
13
14 <command detect_errors="exit_code"><![CDATA[
15 #if $mode.operation == "info":
16 autoBIGS info --retrieve-bigsdb-schemes '$database_origin.bigsdb' --csv '$info_schemes_out'
17 #else if $mode.operation == "st":
18 autoBIGS st --scheme-name '$mode.scheme' '$fasta' '$database_origin.bigsdb' '$mlst_profiles_output'
19 #end if
20 ]]></command>
21 <inputs>
22 <conditional name="database_origin">
23 <param name="origin_select" label="Database Origin" type="select" help="The origin of the database to be accessed" optional="false">
24 <option value="pubmlst" selected="true">PubMLST</option>
25 <option value="institutpasteur">Institut Pasteur</option>
26 </param>
27 <when value="pubmlst">
28 <param name="bigsdb" label="PubMLST Database" type="select" help="Select from a list of sequence definition databases hosted by pubMLST." optional="false">
29 <options from_url="https://rest.pubmlst.org/db" request_method="GET">
30 <postprocess_expression type="ecma5.1"><![CDATA[${
31 let options = []
32 for (let resourceGroup of inputs) {
33 for (let database of resourceGroup.databases) {
34 if (database.name.endsWith("seqdef")) {
35 options.push([database.description, database.name])
36 }
37 }
38 }
39 return options
40 }]]></postprocess_expression>
41 </options>
42 </param>
43 </when>
44 <when value="institutpasteur">
45 <param name="bigsdb" label="PubMLST Database" type="select" help="Select from a list of sequence definition databases hosted by Institut Pasteur." optional="false">
46 <options from_url="https://bigsdb.pasteur.fr/api/db" request_method="GET">
47 <postprocess_expression type="ecma5.1"><![CDATA[${
48 let options = []
49 for (let resourceGroup of inputs) {
50 for (let database of resourceGroup.databases) {
51 if (database.name.endsWith("seqdef")) {
52 options.push([database.description, database.name])
53 }
54 }
55 }
56 return options
57 }]]></postprocess_expression>
58 </options>
59 </param>
60 </when>
61 </conditional>
62 <conditional name="mode">
63 <param name="operation" label="Operation" type="select" help="The operational mode of the tool.">
64 <option value="st" selected="true">Perform sequence typing</option>
65 <option value="info">Retrieve available schemes for database</option>
66 </param>
67 <when value="st">
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."/>
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."/>
70 </when>
71 <when value="info">
72 </when>
73 </conditional>
74 </inputs>
75 <outputs>
76 <data name="mlst_profiles_output" label="${tool.name} on ${on_string}" format="csv">
77 <filter>mode['operation'] == 'st'</filter>
78 </data>
79 <data name="info_schemes_out" label="${tool.name} supported Schemes" format="csv">
80 <filter>mode['operation'] == 'info'</filter>
81 </data>
82 </outputs>
83 <tests>
84 <test expect_num_outputs="1">
85 <param name="origin_select" value="institutpasteur"/>
86 <param name="bigsdb" value="pubmlst_bordetella_seqdef" />
87 <param name="operation" value="st" />
88 <param name="fasta" value="tohama_I_bpertussis_minimized_features.fasta" />
89 <param name="scheme" value="MLST" />
90 <output name="mlst_profiles_output" file="tohama_I_bpertussis_minimized_features_typed.csv" ftype="csv" />
91 </test>
92 <test expect_num_outputs="1">
93 <param name="origin_select" value="institutpasteur"/>
94 <param name="bigsdb" value="pubmlst_bordetella_seqdef" />
95 <param name="operation" value="st" />
96 <param name="fasta" value="B3921_bpertussis_minimized_features.fasta" />
97 <param name="scheme" value="MLST" />
98 <output name="mlst_profiles_output" file="B3921_bpertussis_minimized_features_typed.csv" ftype="csv" />
99 </test>
100 <test expect_num_outputs="1">
101 <param name="origin_select" value="institutpasteur"/>
102 <param name="bigsdb" value="pubmlst_bordetella_seqdef" />
103 <param name="operation" value="st" />
104 <param name="fasta" value="B3913_bpertussis_minimized_features.fasta" />
105 <param name="scheme" value="MLST" />
106 <output name="mlst_profiles_output" file="B3913_bpertussis_minimized_features_typed.csv" ftype="csv" />
107 </test>
108 <test expect_num_outputs="1">
109 <param name="origin_select" value="institutpasteur"/>
110 <param name="bigsdb" value="pubmlst_bordetella_seqdef" />
111 <param name="operation" value="st" />
112 <param name="fasta" value="tohama_I_bpertussis_minimized_features.fasta,B3913_bpertussis_minimized_features.fasta,B3921_bpertussis_minimized_features.fasta" />
113 <param name="scheme" value="MLST" />
114 <output name="mlst_profiles_output">
115 <assert_contents>
116 <has_n_lines n="4"/>
117 <has_text text="id,st,clonal-complex,adk,fumC,glyA,icd,pepA,pgm,tyrB"/>
118 </assert_contents>
119 </output>
120 </test>
121 <test expect_num_outputs="1">
122 <param name="origin_select" value="institutpasteur"/>
123 <param name="bigsdb" value="pubmlst_bordetella_seqdef" />
124 <param name="operation" value="info" />
125 <output name="info_schemes_out">
126 <assert_contents>
127 <has_text text="Name,ID"/>
128 <has_text text="MLST,3"/>
129 </assert_contents>
130 </output>
131 </test>
132 </tests>
133 <help><![CDATA[
134 What is autoBIGS
135 ================
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.
137
138 Support for typing schemes other than MLST
139 ==========================================
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.
141
142 Performing Sequence Typing
143 ==========================
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.
145
146 Special behaviour for FASTAs with multiple sequences
147 ====================================================
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.
149
150 In the case all sequences in a given FASTA have the same ID, autoBIGS will not repeat these names in the output row.
151
152 More Information
153 ================
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.
155
156
157 .. _autoBIGS.cli GitHub repository: https://github.com/Syph-and-VPD-Lab/autoBIGS.cli
158 .. _autoBIGS.cli issues: https://github.com/Syph-and-VPD-Lab/autoBIGS.cli/issues
159 .. _autoBIGS.galaxy: https://github.com/Syph-and-VPD-Lab/autoBIGS.galaxy
160 .. _autoBIGS.galaxy issues: https://github.com/Syph-and-VPD-Lab/autoBIGS.galaxy/issues
161 ]]></help>
162 <citations>
163 <citation type="bibtex">
164 @book{Deng2025RealYHD,
165 title = {Syph-and-VPD-Lab/autoBIGS.cli},
166 url = {https://github.com/Syph-and-VPD-Lab/autoBIGS.cli},
167 author = {Deng, Harrison},
168 date = {2025-01-24},
169 year = {2025},
170 month = {1},
171 day = {24},
172 }
173 </citation>
174 </citations>
175 </tool>