annotate cheetah.xml @ 0:a3bb4353fb00 draft default tip

"planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
author brinkmanlab
date Tue, 28 Jan 2020 15:33:51 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
1 <tool id="cheetah" name="Cheetah" version="1.0" profile="16.04">
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
2 <description>Generate reports using Galaxies built in Cheetah template engine and include information about datasets</description>
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
3 <command><![CDATA[
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
4 mv $body $outfile
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
5 ]]></command>
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
6 <configfiles>
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
7 <configfile name="body"><![CDATA[
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
8 #set $template_path = '/'.join([$__tool_data_path__, "cheetah", $template])
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
9 #import os
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
10 #if '..' not in $template and $os.path.isfile($template_path)
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
11 #include $template_path
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
12 #else
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
13 <html>
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
14 <body>
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
15 $data.name is now complete.
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
16 #if $hasattr(__app__.config, "public_url")
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
17 You can view it <a href="${__app__.config.public_url}/datasets/${data.dataset.id}/display">here</a>.
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
18 #end if
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
19 </body>
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
20 </html>
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
21 #end if
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
22 ]]></configfile>
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
23 </configfiles>
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
24 <inputs>
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
25 <param name="data" type="data" format="data" multiple="true" label="Data" />
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
26 <repeat name="extras" title="Extras">
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
27 <param name="extra" type="text" label="Extra data to make available in the template body" />
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
28 </repeat>
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
29 <param name="template" type="text" value="template.html" label="Template" help="Relative path of template to use in tool-data/cheetah/" />
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
30 </inputs>
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
31 <outputs>
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
32 <data name="outfile" format="txt" />
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
33 </outputs>
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
34 <help><![CDATA[
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
35 Generate reports using Galaxies built in Cheetah template engine and include information about datasets
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
36
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
37 Templates are parsed using Galaxies Cheeta Template Engine. The variables available are everything that is available to a tool including:
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
38 - $data Dataset instance passed to the tool input
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
39 - $extras[].extra List of extras specified in the tool parameters
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
40 - $template Relative path to the current template
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
41
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
42 See this tools xml for an example template.
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
43 ]]></help>
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
44 <citations>
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
45 <citation type="doi">10.5281/zenodo.3364789</citation>
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
46 </citations>
a3bb4353fb00 "planemo upload for repository https://github.com/brinkmanlab/galaxy-tools/tree/master/cheetah commit e773feeb6feb9d533eef40ae5cead068e46f596e"
brinkmanlab
parents:
diff changeset
47 </tool>