annotate toolfactory/rgToolFactory2.xml @ 123:0566e2ee9789 draft

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