Mercurial > repos > fubar > tool_factory_2

comparison toolfactory/rgToolFactory2.xml @ 43:e7e9732ebed6 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded
author fubar
date Sun, 16 Aug 2020 08:51:14 -0400
parents
children f8700bed1e17
comparison
equal deleted inserted replaced
42:b938475235e3 43:e7e9732ebed6
1 <tool id="rgTF2" name="toolfactory" version="2.00" profile="16.04" >
2 <description>Scripts into tools</description>
3 <macros>
4 <xml name="io">
5 <repeat name="history_inputs" title="Add a data file from your history to pass in to the script. Use the '+' button as needed"
6 help="USE SMALL SAMPLES because these will be used for the new tool's test. The names will become a history item selector as input for users of the new tool you are making">
7 <param name="input_files" type="data" format="data" label="Select an input file from your history" optional="true" multiple="false"
8 help=""/>
9 <param name="input_formats" type="select" multiple="true" label="Select the datatype(s) that your tool/script accepts as input"
10 help="If your datatype is not listed here, it has to be added in galaxy's datatypes_conf.xml" value="tabular">
11 <options from_parameter="tool.app.datatypes_registry.upload_file_formats">
12 <column name="value" index="0"/>
13 </options>
14 </param>
15 <param name="input_label" type="text" value="" label="This will become the user prompt for the form so please make it informative"
16 help="Note that '~~~' is an internal delimiter so must not appear in this text field - please work around this technical limitation" >
17 <sanitizer invalid_char="">
18 <valid initial="string.printable"> <remove value='~~~'/> </valid>
19 <mapping initial="none"/>
20 </sanitizer>
21 </param>
22 <param name="input_help" type="text" value="parameter_help" label="This will become help text on the form."
23 help="Note that three consecutive ~ cannot be used in this text field - please work around this technical limitation">
24 <sanitizer invalid_char="">
25 <valid initial="string.printable"> <remove value='~~~'/> </valid>
26 <mapping initial="none"/>
27 </sanitizer>
28 </param>
29 <param name="input_CL" type="text" label="Positional: ordinal integer. Argparse: argument name. STDIN if the executable/script expects it"
30 help="If you will pass positional parameters, enter the integer ordinal for this parameter. If Argparse style, '--' will be prepended or '-' if single character" value="">
31 </param>
32 </repeat>
33 <repeat name="history_outputs" title="Add a tool run output file to the user's history from your tool - Use the '+' button to add as many as needed"
34 help="The name will become a history item for users of the new tool you are making containing one of it's outputs">
35 <param name="history_name" type="text" label="Name for this output to appear in new history" optional="false" help=""/>
36 <param name="history_format" type="select" multiple="false" label="Select the datatype for this output"
37 help="If your datatype is not listed here, it has to be added in galaxy's datatypes_conf.xml" value="tabular">
38 <options from_parameter="tool.app.datatypes_registry.upload_file_formats">
39 <column name="value" index="0"/>
40 </options>
41 </param>
42 <param name="history_CL" type="text" label="Positional: ordinal integer. Argparse: argument name expected for this output parameter. Use STDOUT if '>' required."
43 help="If positional parameters, enter the integer ordinal expected for this parameter. If Argparse style, '--' will be prepended or '-' if single character" value=""/>
44 </repeat>
45 </xml>
46 <xml name="additparam">
47 <param name="edit_params" type="select" display="radio" label="Add any additional parameters to the generated tool form so they are user editable?"
48 help="If no (default), users will NOT be able to alter any additional parameters. If yes, these will appear on the tool form as text fields with no validation or sanitizing">
49 <option value="yes">Yes, allow user to edit all additional parameters on the generated tool form</option>
50 <option value="no" selected="true">No - use the fixed values for all additional parameters - no user editing</option>
51 </param>
52
53 <repeat name="additional_parameters" title="Pass additional parameters to the script"
54 help="See examples below to see how these can be parsed by scripts in the various languages">
55 <param name="param_name" type="text" value="parameter_name" label="Choose the name for this parameter">
56 <sanitizer invalid_char="">
57 <valid initial="string.letters,string.digits"/>
58 <mapping initial="none"/>
59 </sanitizer>
60 </param>
61 <param name="param_type" type="select" label="Select the type for this parameter">
62 <option value="text" selected="true">text</option>
63 <option value="integer">integer</option>
64 <option value="float">float</option>
65 </param>
66 <param name="param_value" type="text" value="" label="Enter this parameter's default value"
67 help="Note that '~~~' is an internal delimiter must not appear in this text field - please work around this technical limitation" >
68 <sanitizer invalid_char="">
69 <valid initial="string.printable"> <remove value='~~~'/> </valid>
70 <mapping initial="none"/>
71 </sanitizer>
72 </param>
73 <param name="param_label" type="text" value="parameter_label" label="Enter this parameter's label for the form"
74 help="Note that '~~~' is an internal delimiter so must not appear in this text field - please work around this technical limitation" >
75 <sanitizer invalid_char="">
76 <valid initial="string.printable"> <remove value='~~~'/> </valid>
77 <mapping initial="none"/>
78 </sanitizer>
79 </param>
80 <param name="param_help" type="text" value="parameter_help" label="Help for this parameter"
81 help="Note that three consecutive ~ cannot be used in this text field - please work around this technical limitation" >
82 <sanitizer invalid_char="">
83 <valid initial="string.printable"> <remove value='~~~'/> </valid>
84 <mapping initial="none"/>
85 </sanitizer>
86 </param>
87 <param name="param_CL" type="text" label="Positional ordinal or argparse argument name"
88 help="Using positional parameters, enter the integer ordinal for this parameter on the command line. Using Argparse style, '--' will be prepended on the CL" value="" />
89 <param name="param_CLprefixed" type="text" label="Override the generated default argparse name prefix if not empty - eg ----foo if needed"
90 help="Some targets like Planemo expect an unadorned action like 'test' before --galaxy_root and so on. " value="" />
91
92 </repeat>
93 </xml>
94 <xml name="builtin_dynpar">
95 <param name="interpreter_version" type="text" value=""
96 label="Specific interpreter version to match dependency (Conda) repositories - e.g. for python '3.8.5' Latest if empty"/>
97 <param name="exe_package_version" type="text" value=""
98 label="Executable package version to match dependency (Conda) repositories - e.g. for bwa='0.7.17'. Latest if empty"/>
99 <param name="dynScript" label="Cut and paste the script to be executed here" type="text" value="Script goes here" area="True"
100 help="If there are parameters, either positional or argparse style, the script must parse and use them appropriately">
101 <sanitizer>
102 <valid initial="string.printable">
103 </valid>
104 <mapping initial="none"/>
105 </sanitizer>
106 </param>
107 </xml>
108 <xml name="dynpar">
109 <param name="interpreter_version" type="text" value=""
110 label="Specific interpreter version to match dependency (Conda) repositories - e.g. for python '3.8.5' Latest if empty"/>
111 <param name="exe_package_version" type="text" value=""
112 label="Executable package version to match dependency (Conda) repositories - e.g. for bwa='0.7.17'. Latest if empty"/>
113 <param name="dynScript" label="Cut and paste the script to be executed here" type="text" value="Script goes here" area="True"
114 help="If there are parameters, either positional or argparse style, the script must parse and use them appropriately">
115 <sanitizer>
116 <valid initial="string.printable">
117 </valid>
118 <mapping initial="none"/>
119 </sanitizer>
120 </param>
121 </xml>
122 </macros>
123 <requirements>
124 <requirement type="package">python</requirement>
125 <requirement type="package">galaxyxml</requirement>
126 </requirements>
127 <command interpreter="python"><![CDATA[
128 #import os
129 #set dev_env = os.environ.get('GALAXY_DEVELOPMENT_ENVIRONMENT', '0') == '1'
130 #if not $dev_env and ( $__user_email__ not in $__admin_users__ ):
131 $__tool_directory__/rgToolFactory2.py --bad_user $__user_email__
132 #else:
133 $__tool_directory__/rgToolFactory2.py
134 --runmode "$interexe.interpreter"
135 #if str($interexe.interpreter)=="Executable" or str($interexe.interpreter)=="system":
136 --exe_package="$interexe.exe_package"
137 #if str($interexe.exe_package_version) != 'None' :
138 --exe_package_version="$interexe.exe_package_version"
139 #end if
140 #else:
141 --interpreter_name="$interexe.interpreter" --script_path "$runme"
142 #if str($interexe.interpreter_version) != 'None':
143 --interpreter_version="$interexe.interpreter_version"
144 #end if
145 #end if
146 --tool_name="$tool_name" --user_email="$__user_email__" --citations="$citeme" --parampass="$ppass.parampass"
147 #if str($makeMode.make_Tool)=="yes":
148 --make_Tool="$makeMode.make_Tool"
149 --tool_desc="$makeMode.tool_desc"
150 --tool_version="$makeMode.tool_version"
151 --help_text="$helpme"
152 --new_tool="$new_tool"
153 #end if
154 #if $ppass.parampass != '0':
155 #if str($ppass.edit_params) == "yes":
156 --edit_additional_parameters
157 #end if
158 #for apar in $ppass.additional_parameters:
159 --additional_parameters="$apar.param_name~~~$apar.param_value~~~$apar.param_label~~~$apar.param_help~~~$apar.param_type~~~$apar.param_CL~~~$apar.param_CLprefixed"
160 #end for
161 #end if
162
163 #for $intab in $ppass.history_inputs:
164 --input_files="$intab.input_files~~~$intab.input_CL~~~$intab.input_formats~~~$intab.input_label~~~$intab.input_help"
165 #end for
166
167
168 #for $otab in $ppass.history_outputs:
169 --output_files "$otab.history_name~~~$otab.history_format~~~$otab.history_CL"
170 #end for
171 #end if
172 ]]></command>
173 <configfiles>
174 <configfile name="runme">
175
176 #if $interexe.interpreter != "Executable" and $interexe.interpreter != "system" :
177 ${interexe.dynScript}
178 #else:
179 $tool_name
180 #end if
181 </configfile>
182 <configfile name="helpme">
183 #if $makeMode.make_Tool == "yes":
184 ${makeMode.help_text}
185 #else
186 $tool_name help goes here
187 #end if
188 </configfile>
189 <configfile name="citeme">
190 #if $makeMode.make_Tool == "yes":
191 #for $citation in $makeMode.citations:
192 #if $citation.citation_type.type == "bibtex":
193 **ENTRY**bibtex
194 ${citation.citation_type.bibtex}
195 #else
196 **ENTRY**doi
197 ${citation.citation_type.doi}
198 #end if
199 #end for
200 #end if
201 </configfile>
202 </configfiles>
203 <inputs>
204
205 <param name="tool_name" type="text" value="tool1" label="New tool ID and title for outputs"
206 help="This will become the toolshed repository name so choose thoughtfully to avoid namespace clashes with other tool writers. lower case, digits and underscores only">
207 <sanitizer invalid_char="">
208 <valid initial="string.letters,string.digits">
209 <add value="_"/>
210 </valid>
211 </sanitizer>
212 </param>
213 <conditional name="interexe">
214 <param name="interpreter" type="select" label="For binaries, choose 'Executable'. Otherwise choose the interpreter for your code"
215 help = "If executable, the supplied package will become a requirement so must match the tool dependency resolver package name - conda is the default.">
216 <option value="Executable" selected="true">An executable binary to be provided and managed by the Conda dependency management subsystem</option>
217 <option value="python">python</option>
218 <option value="r-base">Rscript</option>
219 <option value="perl">perl</option>
220 <option value="bash">bash</option>
221 <option value="sh">sh</option>
222 <option value="system" >A system executable found on the path such as awk/sed</option>
223 <option value="specialtestcaseinterpreterpython" >for testing only - do not use me please</option>
224 </param>
225 <when value="Executable">
226 <param name="exe_package" type="text" value="" label="Executable package name in dependency (Conda) repositories - e.g. 'bwa'" optional="false"/>
227 <param name="exe_package_version" type="text" value="" label="Executable package version to match dependency (Conda) repositories - e.g. for bwa='0.7.17'. Latest if empty" />
228 </when>
229 <when value="system">
230 <param name="exe_package" type="text" value="" label="System executable to run" optional="false"/>
231 <param name="exe_package_version" type="text" value=""
232 label="Executable package version to match dependency (Conda) repositories - e.g. for bwa='0.7.17'. Latest if empty"/>
233 </when>
234 <when value = "python">
235 <expand macro="dynpar" />
236 </when>
237 <when value = "r-base">
238 <expand macro="dynpar" />
239 </when>
240 <when value = "perl">
241 <expand macro="dynpar" />
242 </when>
243 <when value = "bash">
244 <expand macro="builtin_dynpar" />
245 </when>
246 <when value = "sh">
247 <expand macro="builtin_dynpar" />
248 </when>
249 <when value = "specialtestcaseinterpreterpython">
250 <expand macro="builtin_dynpar" />
251 </when>
252 </conditional>
253 <conditional name = "ppass">
254
255 <param name="parampass" type="select" display="radio" label="Command line parameter passing method to use">
256 <option value="argparse" selected="true">Argparse style: passed in the form of '--[clname] [value]'</option>
257 <option value="positional">Positional: Passed in the order of positional ordinals '...foo.bam bar.idx zot.xls'</option>
258 <option value="0">No parameters needed because tool reads selected input file from STDIN and writes STDOUT with new history output"</option>
259 </param>
260 <when value = "argparse">
261 <expand macro="io" />
262 <expand macro="additparam" />
263 </when>
264 <when value = "positional">
265 <expand macro="io" />
266 <expand macro="additparam" />
267 </when>
268 <when value = "0">
269 <expand macro="io"/>
270 </when>
271 </conditional>
272 <conditional name="makeMode">
273 <param name="make_Tool" type="select" display="radio" label="Generate new tool as a tar.gz file ready to upload to a toolshed repository"
274 help="Generate a toolshed archive - upload to a toolshed from where it can be auto-installed via the Galaxy admin functions" >
275 <option value="yes">Generate a Galaxy ToolShed compatible toolshed.gz</option>
276 <option value="" selected="true">No. Just run the script please</option>
277 </param>
278 <when value = "yes">
279 <param name="tool_version" label="Tool Version - bump this to warn users trying to redo old analyses" type="text" value="0.01"
280 help="If you change your script and regenerate the 'same' tool, you should inform Galaxy (and users) by changing (bumping is traditional) this number"/>
281 <param name="tool_desc" label="Tool Description" type="text" value=""
282 help="Supply a brief tool description for the Galaxy tool menu entry (optional - appears after the tool name)" />
283 <param name="help_text" label="Tool form documentation and help text for users" type="text" area="true"
284 value="**What it Does**"
285 help="Supply the brief user documentation to appear on the new tool form as reStructured text - http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html" >
286 <sanitizer>
287 <valid initial="string.printable">
288 </valid>
289 <mapping initial="none"/>
290 </sanitizer>
291 </param>
292 <repeat name="citations" title="Citation">
293 <conditional name="citation_type">
294 <param name="type" type="select" display="radio" label="Citation Type">
295 <option value="doi">DOI</option>
296 <option value="bibtex">BibTeX</option>
297 </param>
298 <when value="doi">
299 <param name="doi" label="DOI" type="text" value=""
300 help="Supply a DOI (e.g. doi: 10.1111/j.1740-9713.2007.00258.x) that should be cited when this tool is used in published research." />
301 </when>
302 <when value="bibtex">
303 <param name="bibtex" label="BibTex" type="text" area="true"
304 help="Supply a BibTex entry that should be cited when this tool is used in published research." value="" >
305 <sanitizer>
306 <valid initial="string.printable">
307 </valid>
308 <mapping initial="none"/>
309 </sanitizer>
310 </param>
311 </when>
312 </conditional>
313 </repeat>
314 </when>
315 <when value = "">
316 </when>
317 </conditional>
318 </inputs>
319 <outputs>
320
321 <data format="tgz" name="new_tool" label="${tool_name}_toolshed.tgz" >
322 <filter>makeMode['make_Tool'] == "yes"</filter>
323 </data>
324
325 <collection name="TF_run_report" type="list" label="${tool_name} outputs">
326 <discover_datasets pattern="__name__" directory="TF_run_report_tempdir" format="txt"/>
327 </collection>
328
329
330 </outputs>
331 <tests>
332 <test>
333 <param name="input_files" value="input1_sample" />
334 <param name="input_CL" value="1" />
335 <param name="input_formats" value="txt" />
336 <param name="input_label" value="input" />
337 <param name="input_help" value="help" />
338 <param name="tool_name" value="pyrevpos" />
339 <param name="parampass" value="positional" />
340 <param name="make_Tool" value="yes" />
341 <param name="tool_version" value="0.01" />
342 <param name="tool_desc" value="positional reverse" />
343 <param name="help_text" value="help text goes here" />
344 <param name="interpreter" value="python"/>
345 <param name="history_name" value="output2_sample" />
346 <param name="history_format" value="txt" />
347 <param name="history_CL" value="2" />
348 <param name="dynScript" value="import sys; inp = sys.argv[1]; outp = sys.argv[2]; inlist = open(inp,'r').readlines(); o = open(outp,'w'); rs = [''.join(list(reversed(x.rstrip()))) for x in inlist]; o.write('\n'.join(rs)); o.close()"/>
349 <output name="new_tool" file="toolfactory_pyrevpos_tgz_sample" compare="sim_size" delta="6000" />
350 <!-- <output name="output" file="output2_sample" ftype="txt" compare="diff" lines_diff = "10" /> -->
351 </test>
352 </tests>
353 <help>
354
355 .. class:: warningmark
356
357 **Details and attribution**
358 (see GTF_)
359
360 **Local Admins ONLY**
361 Only users whose IDs found in the local admin_user configuration setting in universe_wsgi.ini can run this tool.
362
363 **If you find a bug**
364 Please raise an issue, or even better, submit a pull request fixing it, on the github repository GTF_
365
366 **What it does**
367 This tool optionally generates normal workflow compatible first class Galaxy tools
368
369 Generated tools can run existing binary packages that become requirements, existing scripts, or new scripts pasted into this tool form.
370 Pasted scripts are written so they are part of the new tool and cannot be adjusted by the downstream user.
371 Binary packages are managed by the dependency subsystem - conda usually, so anything in bioconda or conda_forge is available for example.
372
373 Any number of parameters can be built into the new tool form for passing in to the script or executable at runtime.
374 These can be editable by the downstream user or baked in.
375
376 When you run this tool, your executable or script and supplied parameter values will be run to produce a canonical
377 set of outputs - these are used to construct a test for the new tool.
378
379 If tool generation is required, a new tarball compatible with any Galaxy toolshed is created.
380 It can be unpacked in your galaxy/tools directory and manually added to tool_conf.xml, or
381 installed into any toolshed from where it can be installed into your Galaxy.
382
383
384 .. class:: warningmark
385
386 **Note to system administrators**
387 This tool offers *NO* built in protection against malicious scripts. It should only be installed on private/personnal Galaxy instances.
388 Admin_users will have the power to do anything they want as the Galaxy user if you install this tool.
389
390 .. class:: warningmark
391
392 **Use on public servers** is STRONGLY discouraged for obvious reasons
393
394 The tools generated by this tool will run just as securely as any other normal installed Galaxy tool but like any other new tools, should always be checked carefully before installation.
395 We recommend that you follow the good code hygiene practices associated with safe toolshed practices.
396
397 Here's a sample python script that can be cut and pasted into the tool form, suitable for positional parameter passing:
398
399 ::
400
401 # reverse order of text by row
402 import sys
403 inp = sys.argv[1]
404 outp = sys.argv[2]
405 i = open(inp,'r').readlines()
406 o = open(outp,'w')
407 for row in i:
408 rs = row.rstrip()
409 rs = list(rs)
410 rs.reverse()
411 o.write(''.join(rs))
412 o.write('\n')
413 o.close()
414
415 With argparse style parameters:
416
417 ::
418
419 # reverse order of text by row
420 import argparse
421 parser = argparse.ArgumentParser()
422 a = parser.add_argument
423 a('--infile',default='')
424 a('--outfile',default=None)
425 args = parser.parse_args()
426 inp = args.infile
427 outp = args.outfile
428 i = open(inp,'r').readlines()
429 o = open(outp,'w')
430 for row in i:
431 rs = row.rstrip()
432 rs = list(rs)
433 rs.reverse()
434 o.write(''.join(rs))
435 o.write('\n')
436 o.close()
437
438
439 Paper_ :
440
441 Creating re-usable tools from scripts: The Galaxy Tool Factory
442 Ross Lazarus; Antony Kaspi; Mark Ziemann; The Galaxy Team
443 Bioinformatics 2012; doi: 10.1093/bioinformatics/bts573
444
445 **Licensing**
446
447 Copyright Ross Lazarus (ross period lazarus at gmail period com) May 2012
448 All rights reserved.
449 Licensed under the LGPL_
450
451 .. _LGPL: http://www.gnu.org/copyleft/lesser.html
452 .. _GTF: https://github.com/fubar2/toolfactory
453 .. _Paper: http://bioinformatics.oxfordjournals.org/cgi/reprint/bts573
454
455
456 </help>
457 <citations>
458 <citation type="doi">10.1093/bioinformatics/bts573</citation>
459 </citations>
460 </tool>
461
462