annotate toolfactory/rgToolFactory2.xml @ 56:68fbdbe35f08 draft

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