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