|
48
|
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="exe_package" type="hidden" value="" />
|
|
|
96 <param name="exe_package_version" type="hidden" value="" />
|
|
|
97 <param name="cl_override" type="hidden" value="" />
|
|
|
98 <param name="interpreter_version" type="hidden" value=""/>
|
|
|
99 <param name="dependencies" type="hidden" value="" />
|
|
|
100 <param name="dynScript" label="Cut and paste the script to be executed here" type="text" value="Script goes here" area="True"
|
|
|
101 help="If there are parameters, either positional or argparse style, the script must parse and use them appropriately">
|
|
|
102 <sanitizer>
|
|
|
103 <valid initial="string.printable">
|
|
|
104 </valid>
|
|
|
105 <mapping initial="none"/>
|
|
|
106 </sanitizer>
|
|
|
107 </param>
|
|
|
108 </xml>
|
|
|
109 <xml name="dynpar">
|
|
|
110 <param name="exe_package" type="hidden" value="" />
|
|
|
111 <param name="exe_package_version" type="hidden" value="" />
|
|
|
112 <param name="cl_override" type="hidden" value="" />
|
|
|
113 <param name="dependencies" type="text" value="" label="List additional dependencies - e.g. 'planemo, ephemeris'" help="These will be managed by Conda" />
|
|
|
114 <param name="interpreter_version" type="text" value=""
|
|
|
115 label="Specific interpreter version to match dependency (Conda) repositories - e.g. for python '3.8.5' Latest if empty"/>
|
|
|
116 <param name="dynScript" label="Cut and paste the script to be executed here" type="text" value="Script goes here" area="True"
|
|
|
117 help="If there are parameters, either positional or argparse style, the script must parse and use them appropriately">
|
|
|
118 <sanitizer>
|
|
|
119 <valid initial="string.printable">
|
|
|
120 </valid>
|
|
|
121 <mapping initial="none"/>
|
|
|
122 </sanitizer>
|
|
|
123 </param>
|
|
|
124 </xml>
|
|
|
125 </macros>
|
|
|
126 <requirements>
|
|
|
127 <requirement type="package">python</requirement>
|
|
|
128 <requirement type="package">galaxyxml</requirement>
|
|
|
129 <requirement type="package">planemo</requirement>
|
|
|
130 <requirement type="package">yaml</requirement>
|
|
|
131 <requirement type="package">lxml</requirement>
|
|
|
132 </requirements>
|
|
|
133 <command interpreter="python"><![CDATA[
|
|
|
134 #import os
|
|
|
135 #set dev_env = os.environ.get('GALAXY_DEVELOPMENT_ENVIRONMENT', '0') == '1'
|
|
|
136 #if not $dev_env and ( $__user_email__ not in $__admin_users__ ):
|
|
|
137 $__tool_directory__/rgToolFactory2.py --bad_user $__user_email__
|
|
|
138 #else:
|
|
|
139 $__tool_directory__/rgToolFactory2.py
|
|
|
140 --dependencies "$interexe.dependencies"
|
|
|
141 --runmode "$interexe.interpreter"
|
|
|
142 #if len(str($interexe.cl_override)) > 0:
|
|
|
143 --cl_override "$interexe.cl_override"
|
|
|
144 #end if
|
|
|
145 #if str($interexe.interpreter)=="Executable" or str($interexe.interpreter)=="system":
|
|
|
146 --exe_package="$interexe.exe_package"
|
|
|
147 #if $interexe.exe_package_version:
|
|
|
148 --exe_package_version="$interexe.exe_package_version"
|
|
|
149 #end if
|
|
|
150 #else:
|
|
|
151 --interpreter_name="$interexe.interpreter" --script_path "$runme"
|
|
|
152 #if str($interexe.interpreter_version) != 'None':
|
|
|
153 --interpreter_version="$interexe.interpreter_version"
|
|
|
154 #end if
|
|
|
155 #end if
|
|
|
156 --tool_name="$tool_name" --user_email="$__user_email__" --citations="$citeme" --parampass="$ppass.parampass"
|
|
|
157 #if str($makeMode.make_Tool)=="yes":
|
|
|
158 --planemo_test "$makeMode.planemo_test"
|
|
|
159 --make_Tool="$makeMode.make_Tool"
|
|
|
160 --tool_desc="$makeMode.tool_desc"
|
|
|
161 --tool_version="$makeMode.tool_version"
|
|
|
162 --help_text="$helpme"
|
|
|
163 --new_tool="$new_tool"
|
|
|
164 #end if
|
|
|
165 #if $ppass.parampass != '0':
|
|
|
166 #if str($ppass.edit_params) == "yes":
|
|
|
167 --edit_additional_parameters
|
|
|
168 #end if
|
|
|
169 #for apar in $ppass.additional_parameters:
|
|
|
170 --additional_parameters="$apar.param_name~~~$apar.param_value~~~$apar.param_label~~~$apar.param_help~~~$apar.param_type~~~$apar.param_CL~~~$apar.param_CLprefixed"
|
|
|
171 #end for
|
|
|
172 #end if
|
|
|
173 #for $intab in $ppass.history_inputs:
|
|
|
174 --input_files="$intab.input_files~~~$intab.input_CL~~~$intab.input_formats~~~$intab.input_label~~~$intab.input_help"
|
|
|
175 #end for
|
|
|
176 #for $otab in $ppass.history_outputs:
|
|
|
177 --output_files "$otab.history_name~~~$otab.history_format~~~$otab.history_CL"
|
|
|
178 #end for
|
|
|
179 #end if
|
|
|
180 ]]></command>
|
|
|
181 <configfiles>
|
|
|
182 <configfile name="runme">
|
|
|
183
|
|
|
184 #if $interexe.interpreter != "Executable" and $interexe.interpreter != "system" :
|
|
|
185 ${interexe.dynScript}
|
|
|
186 #else:
|
|
|
187 $tool_name
|
|
|
188 #end if
|
|
|
189 </configfile>
|
|
|
190 <configfile name="helpme">
|
|
|
191 #if $makeMode.make_Tool == "yes":
|
|
|
192 ${makeMode.help_text}
|
|
|
193 #else
|
|
|
194 $tool_name help goes here
|
|
|
195 #end if
|
|
|
196 </configfile>
|
|
|
197 <configfile name="citeme">
|
|
|
198 #if $makeMode.make_Tool == "yes":
|
|
|
199 #for $citation in $makeMode.citations:
|
|
|
200 #if $citation.citation_type.type == "bibtex":
|
|
|
201 **ENTRY**bibtex
|
|
|
202 ${citation.citation_type.bibtex}
|
|
|
203 #else
|
|
|
204 **ENTRY**doi
|
|
|
205 ${citation.citation_type.doi}
|
|
|
206 #end if
|
|
|
207 #end for
|
|
|
208 #end if
|
|
|
209 </configfile>
|
|
|
210 </configfiles>
|
|
|
211 <inputs>
|
|
|
212
|
|
|
213 <param name="tool_name" type="text" value="tool1" label="New tool ID and title for outputs"
|
|
|
214 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">
|
|
|
215 <sanitizer invalid_char="">
|
|
|
216 <valid initial="string.letters,string.digits">
|
|
|
217 <add value="_"/>
|
|
|
218 </valid>
|
|
|
219 </sanitizer>
|
|
|
220 </param>
|
|
|
221 <conditional name="interexe">
|
|
|
222 <param name="interpreter" type="select" label="Tool model: For a managed external dependency, choose 'Executable', or choose an interpreter for a script"
|
|
|
223 help = "If executable, the supplied package will become a requirement so must match the tool dependency resolver package name - conda is the default.">
|
|
|
224 <option value="Executable" selected="true">An executable binary to be provided and managed by the Conda dependency management subsystem</option>
|
|
|
225 <option value="python">Use Python to run the script pasted below</option>
|
|
|
226 <option value="r-base">Use R (Rscript) to run the script pasted below</option>
|
|
|
227 <option value="perl">Use a depency managed Perl to run the script pasted below</option>
|
|
|
228 <option value="bash">Use the system bash to run the script pasted below</option>
|
|
|
229 <option value="sh">Use sh to run the script pasted below</option>
|
|
|
230 <option value="system" >Use a different system executable such as sed</option>
|
|
|
231 </param>
|
|
|
232 <when value="Executable">
|
|
|
233 <param name="exe_package" type="text" value="" label="Executable/package name for Ddependency manager - e.g. 'bwa'" optional="false"/>
|
|
|
234 <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" />
|
|
|
235 <param name="cl_override" type="text" value="" label="Command line override prefix - e.g. for ephemeris prepend the specific function such as 'workflow_install'"
|
|
|
236 help="Some packages like ephemerisand planemo require a sub-command - eg planemo test - before parameters are passed. Supply that here"/>
|
|
|
237 <param name="dependencies" type="hidden" value="" />
|
|
|
238 </when>
|
|
|
239 <when value="system">
|
|
|
240 <param name="dependencies" type="hidden" value="" />
|
|
|
241 <param name="exe_package" type="text" value="" label="System executable to run - e.g. awk"/>
|
|
|
242 <param name="exe_package_version" type="hidden" value="" />
|
|
|
243 <param name="cl_override" type="text" value="" label="Command line override prefix - e.g. for sed or awk, prepend this before the i/o parameters"
|
|
|
244 help="This may help finesse a command line - inputs and output will be passed as you specify below"/>
|
|
|
245 </when>
|
|
|
246 <when value = "python">
|
|
|
247 <expand macro="dynpar" />
|
|
|
248 </when>
|
|
|
249 <when value = "r-base">
|
|
|
250 <expand macro="dynpar" />
|
|
|
251 </when>
|
|
|
252 <when value = "perl">
|
|
|
253 <expand macro="dynpar" />
|
|
|
254 </when>
|
|
|
255 <when value = "bash">
|
|
|
256 <expand macro="builtin_dynpar" />
|
|
|
257 </when>
|
|
|
258 <when value = "sh">
|
|
|
259 <expand macro="builtin_dynpar" />
|
|
|
260 </when>
|
|
|
261 </conditional>
|
|
|
262 <conditional name = "ppass">
|
|
|
263
|
|
|
264 <param name="parampass" type="select" display="radio" label="Command line parameter passing method to use">
|
|
|
265 <option value="argparse" selected="true">Argparse style: passed in the form of '--[clname] [value]'</option>
|
|
|
266 <option value="positional">Positional: Passed in the order of positional ordinals '...foo.bam bar.idx zot.xls'</option>
|
|
|
267 <option value="0">No parameters needed because tool reads selected input file from STDIN and writes STDOUT with new history output"</option>
|
|
|
268 </param>
|
|
|
269 <when value = "argparse">
|
|
|
270 <expand macro="io" />
|
|
|
271 <expand macro="additparam" />
|
|
|
272 </when>
|
|
|
273 <when value = "positional">
|
|
|
274 <expand macro="io" />
|
|
|
275 <expand macro="additparam" />
|
|
|
276 </when>
|
|
|
277 <when value = "0">
|
|
|
278 <expand macro="io"/>
|
|
|
279 </when>
|
|
|
280 </conditional>
|
|
|
281 <conditional name="makeMode">
|
|
|
282 <param name="make_Tool" type="select" display="radio" label="Generate new tool as a tar.gz file ready to upload to a toolshed repository"
|
|
|
283 help="Generate a toolshed archive - upload to a toolshed from where it can be auto-installed via the Galaxy admin functions" >
|
|
|
284 <option value="yes">Generate a Galaxy ToolShed compatible toolshed.gz</option>
|
|
|
285 <option value="" selected="true">No. Just run the script please</option>
|
|
|
286 </param>
|
|
|
287 <when value = "yes">
|
|
|
288 <param name="planemo_test" type="select" display="radio" label="Use planemo to test the new tool (takes a while..)"
|
|
|
289 help="Planemo will test the tool, upload it to the local toolshed and install to this Galaxy for additional testing" >
|
|
|
290 <option value="yes" selected="true">Test with planemo and install to this Galaxy if passes</option>
|
|
|
291 <option value="">No test/install</option>
|
|
|
292 </param>
|
|
|
293 <param name="tool_version" label="Tool Version - bump this to warn users trying to redo old analyses" type="text" value="0.01"
|
|
|
294 help="If you change your script and regenerate the 'same' tool, you should inform Galaxy (and users) by changing (bumping is traditional) this number"/>
|
|
|
295 <param name="tool_desc" label="Tool Description" type="text" value=""
|
|
|
296 help="Supply a brief tool description for the Galaxy tool menu entry (optional - appears after the tool name)" />
|
|
|
297 <param name="help_text" label="Tool form documentation and help text for users" type="text" area="true"
|
|
|
298 value="**What it Does**"
|
|
|
299 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" >
|
|
|
300 <sanitizer>
|
|
|
301 <valid initial="string.printable">
|
|
|
302 </valid>
|
|
|
303 <mapping initial="none"/>
|
|
|
304 </sanitizer>
|
|
|
305 </param>
|
|
|
306 <repeat name="citations" title="Citation">
|
|
|
307 <conditional name="citation_type">
|
|
|
308 <param name="type" type="select" display="radio" label="Citation Type">
|
|
|
309 <option value="doi">DOI</option>
|
|
|
310 <option value="bibtex">BibTeX</option>
|
|
|
311 </param>
|
|
|
312 <when value="doi">
|
|
|
313 <param name="doi" label="DOI" type="text" value=""
|
|
|
314 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." />
|
|
|
315 </when>
|
|
|
316 <when value="bibtex">
|
|
|
317 <param name="bibtex" label="BibTex" type="text" area="true"
|
|
|
318 help="Supply a BibTex entry that should be cited when this tool is used in published research." value="" >
|
|
|
319 <sanitizer>
|
|
|
320 <valid initial="string.printable">
|
|
|
321 </valid>
|
|
|
322 <mapping initial="none"/>
|
|
|
323 </sanitizer>
|
|
|
324 </param>
|
|
|
325 </when>
|
|
|
326 </conditional>
|
|
|
327 </repeat>
|
|
|
328 </when>
|
|
|
329 <when value = "">
|
|
|
330 </when>
|
|
|
331 </conditional>
|
|
|
332 </inputs>
|
|
|
333 <outputs>
|
|
|
334
|
|
|
335 <data format="tgz" name="new_tool" label="${tool_name}_toolshed.tgz" >
|
|
|
336 <filter>makeMode['make_Tool'] == "yes"</filter>
|
|
|
337 </data>
|
|
|
338
|
|
|
339 <collection name="TF_run_report" type="list" label="${tool_name} outputs">
|
|
|
340 <discover_datasets pattern="__name_and_ext__" directory="TF_run_report_tempdir" />
|
|
|
341 </collection>
|
|
|
342
|
|
|
343
|
|
|
344 </outputs>
|
|
|
345 <tests>
|
|
|
346 <test>
|
|
|
347 <param name="input_files" value="input1_sample" />
|
|
|
348 <param name="input_CL" value="1" />
|
|
|
349 <param name="input_formats" value="txt" />
|
|
|
350 <param name="input_label" value="input" />
|
|
|
351 <param name="input_help" value="help" />
|
|
|
352 <param name="tool_name" value="pyrevpos" />
|
|
|
353 <param name="parampass" value="positional" />
|
|
|
354 <param name="make_Tool" value="yes" />
|
|
|
355 <param name="tool_version" value="0.01" />
|
|
|
356 <param name="tool_desc" value="positional reverse" />
|
|
|
357 <param name="help_text" value="help text goes here" />
|
|
|
358 <param name="interpreter" value="python"/>
|
|
|
359 <param name="history_name" value="output2_sample" />
|
|
|
360 <param name="history_format" value="txt" />
|
|
|
361 <param name="history_CL" value="2" />
|
|
|
362 <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()"/>
|
|
|
363 <output name="new_tool" file="toolfactory_pyrevpos_tgz_sample" compare="sim_size" delta="6000" />
|
|
|
364 <!-- <output name="output" file="output2_sample" ftype="txt" compare="diff" lines_diff = "10" /> -->
|
|
|
365 </test>
|
|
|
366 </tests>
|
|
|
367 <help>
|
|
|
368
|
|
|
369 .. class:: warningmark
|
|
|
370
|
|
|
371 **Details and attribution**
|
|
|
372 (see GTF_)
|
|
|
373
|
|
|
374 **Local Admins ONLY**
|
|
|
375 Only users whose IDs found in the local admin_user configuration setting in universe_wsgi.ini can run this tool.
|
|
|
376
|
|
|
377 **If you find a bug**
|
|
|
378 Please raise an issue, or even better, submit a pull request fixing it, on the github repository GTF_
|
|
|
379
|
|
|
380 **What it does**
|
|
|
381 This tool optionally generates normal workflow compatible first class Galaxy tools
|
|
|
382
|
|
|
383 Generated tools can run existing binary packages that become requirements, existing scripts, or new scripts pasted into this tool form.
|
|
|
384 Pasted scripts are written so they are part of the new tool and cannot be adjusted by the downstream user.
|
|
|
385 Binary packages are managed by the dependency subsystem - conda usually, so anything in bioconda or conda_forge is available for example.
|
|
|
386
|
|
|
387 Any number of parameters can be built into the new tool form for passing in to the script or executable at runtime.
|
|
|
388 These can be editable by the downstream user or baked in.
|
|
|
389
|
|
|
390 When you run this tool, your executable or script and supplied parameter values will be run to produce a canonical
|
|
|
391 set of outputs - these are used to construct a test for the new tool.
|
|
|
392
|
|
|
393 If tool generation is required, a new tarball compatible with any Galaxy toolshed is created.
|
|
|
394 It can be unpacked in your galaxy/tools directory and manually added to tool_conf.xml, or
|
|
|
395 installed into any toolshed from where it can be installed into your Galaxy.
|
|
|
396
|
|
|
397
|
|
|
398 .. class:: warningmark
|
|
|
399
|
|
|
400 **Note to system administrators**
|
|
|
401 This tool offers *NO* built in protection against malicious scripts. It should only be installed on private/personnal Galaxy instances.
|
|
|
402 Admin_users will have the power to do anything they want as the Galaxy user if you install this tool.
|
|
|
403
|
|
|
404 .. class:: warningmark
|
|
|
405
|
|
|
406 **Use on public servers** is STRONGLY discouraged for obvious reasons
|
|
|
407
|
|
|
408 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.
|
|
|
409 We recommend that you follow the good code hygiene practices associated with safe toolshed practices.
|
|
|
410
|
|
|
411 Here's a sample python script that can be cut and pasted into the tool form, suitable for positional parameter passing:
|
|
|
412
|
|
|
413 ::
|
|
|
414
|
|
|
415 # reverse order of text by row
|
|
|
416 import sys
|
|
|
417 inp = sys.argv[1]
|
|
|
418 outp = sys.argv[2]
|
|
|
419 i = open(inp,'r').readlines()
|
|
|
420 o = open(outp,'w')
|
|
|
421 for row in i:
|
|
|
422 rs = row.rstrip()
|
|
|
423 rs = list(rs)
|
|
|
424 rs.reverse()
|
|
|
425 o.write(''.join(rs))
|
|
|
426 o.write('\n')
|
|
|
427 o.close()
|
|
|
428
|
|
|
429 With argparse style parameters:
|
|
|
430
|
|
|
431 ::
|
|
|
432
|
|
|
433 # reverse order of text by row
|
|
|
434 import argparse
|
|
|
435 parser = argparse.ArgumentParser()
|
|
|
436 a = parser.add_argument
|
|
|
437 a('--infile',default='')
|
|
|
438 a('--outfile',default=None)
|
|
|
439 args = parser.parse_args()
|
|
|
440 inp = args.infile
|
|
|
441 outp = args.outfile
|
|
|
442 i = open(inp,'r').readlines()
|
|
|
443 o = open(outp,'w')
|
|
|
444 for row in i:
|
|
|
445 rs = row.rstrip()
|
|
|
446 rs = list(rs)
|
|
|
447 rs.reverse()
|
|
|
448 o.write(''.join(rs))
|
|
|
449 o.write('\n')
|
|
|
450 o.close()
|
|
|
451
|
|
|
452
|
|
|
453 Paper_ :
|
|
|
454
|
|
|
455 Creating re-usable tools from scripts: The Galaxy Tool Factory
|
|
|
456 Ross Lazarus; Antony Kaspi; Mark Ziemann; The Galaxy Team
|
|
|
457 Bioinformatics 2012; doi: 10.1093/bioinformatics/bts573
|
|
|
458
|
|
|
459 **Licensing**
|
|
|
460
|
|
|
461 Copyright Ross Lazarus (ross period lazarus at gmail period com) May 2012
|
|
|
462 All rights reserved.
|
|
|
463 Licensed under the LGPL_
|
|
|
464
|
|
|
465 .. _LGPL: http://www.gnu.org/copyleft/lesser.html
|
|
|
466 .. _GTF: https://github.com/fubar2/toolfactory
|
|
|
467 .. _Paper: http://bioinformatics.oxfordjournals.org/cgi/reprint/bts573
|
|
|
468
|
|
|
469
|
|
|
470 </help>
|
|
|
471 <citations>
|
|
|
472 <citation type="doi">10.1093/bioinformatics/bts573</citation>
|
|
|
473 </citations>
|
|
|
474 </tool>
|
|
|
475
|
|
|
476
|
