annotate dynamic_tool_wrappers_macros.xml @ 1:cb062cfb7370 draft default tip

planemo upload
author mingchen0919
date Sat, 24 Mar 2018 14:01:48 -0400
parents 4cd5e5e9b030
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
1 <?xml version="1.0" encoding="UTF-8"?>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
2 <macros>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
3 <xml name="rmarkdown_requirements">
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
4 <requirement type="package" version="1.15.0.6-0">pandoc</requirement>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
5 <requirement type="package" version="1.6">r-rmarkdown</requirement>
1
cb062cfb7370 planemo upload
mingchen0919
parents: 0
diff changeset
6 <requirement type="package" version="0.2.2">skewer</requirement>
0
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
7 </xml>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
8 <xml name="stdio">
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
9 <stdio>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
10 <regex match="XXX" source="stderr" level="warning" description="Check the tool log output file for more details."/>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
11 </stdio>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
12 </xml>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
13 <!--Tool name-->
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
14 <xml name="tool_name">
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
15 <param type="select" name="tool_name" multiple="false" label="Tool name">
1
cb062cfb7370 planemo upload
mingchen0919
parents: 0
diff changeset
16 <option value="package" selected="false">skewer</option>
cb062cfb7370 planemo upload
mingchen0919
parents: 0
diff changeset
17 </param>
0
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
18 </xml>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
19 <!--OPTION/ARGUMENT PAIRS and INPUT types-->
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
20 <!--input files-->
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
21 <xml name="option_argument_single_dataset">
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
22 <repeat name="option_argument_single_dataset_repeat" title="INPUT SINGLE DATASET" min="0" default="0">
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
23 <param type="text" name="flag" optional="true" label="flag"/>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
24 <param name="value" type="data" optional="false" multiple="false" label="value"/>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
25 </repeat>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
26 </xml>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
27 <xml name="option_argument_multiple_datasets">
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
28 <repeat name="option_argument_multiple_datasets_repeat" title="INPUT MULTIPLE DATASETS" min="0" default="0">
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
29 <param type="text" name="flag" optional="true" label="flag"/>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
30 <param name="value" type="data" optional="false" multiple="true" label="value"/>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
31 <param type="select" name="delimiter" multiple="false" label="file delimiter">
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
32 <option value=" " selected="false">space</option>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
33 <option value="," selected="false">comma</option>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
34 </param>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
35 </repeat>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
36 </xml>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
37 <!--input path-->
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
38 <xml name="option_argument_path_relative_to_a_tool">
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
39 <repeat name="option_argument_path_relative_to_a_tool_repeat" title="INPUT PATH: path relative to a tool" min="0" default="0">
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
40 <param type="text" name="flag" optional="true" label="flag"/>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
41 <param name="a_tool_output_dir" type="data" optional="false" multiple="false" label="a tool output directory"/>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
42 <param type="text" name="value" optional="true" label="value"/>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
43 </repeat>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
44 </xml>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
45 <xml name="option_argument_path_relative_to_this_tool">
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
46 <repeat name="option_argument_path_relative_to_this_tool_repeat" title="INPUT PATH: path relative to this tool" min="0" default="0">
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
47 <param type="text" name="flag" optional="true" label="flag"/>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
48 <param type="text" name="value" optional="false" label="value"/>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
49 <param type="select" name="path_type" multiple="false" label="path type">
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
50 <option value="file_path" selected="false">file path</option>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
51 <option value="dir_path" selected="false">directory path</option>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
52 </param>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
53 </repeat>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
54 </xml>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
55 <!--input values: string, float and integer-->
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
56 <xml name="option_argument_string_float_integer">
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
57 <repeat name="option_argument_string_float_integer_repeat" title="INPUT VALUE: string/float/integer" min="0" default="0">
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
58 <param type="text" name="flag" label="flag"/>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
59 <param type="text" name="value" label="value"/>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
60 </repeat>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
61 </xml>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
62 <!--output set-->
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
63 <xml name="output_set">
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
64 <data format="html" name="report" label="${tool.name} report"/>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
65 <data format="txt" name="tool_help_doc" label="${tool.name} help doc"/>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
66 <data format="txt" name="tool_output_dir" label="${tool.name} output directory"/>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
67 <data format="txt" name="tool_log" label="${tool.name} log"/>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
68 </xml>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
69 <!--shell command fragment-->
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
70 <xml name="shell_command">
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
71 <command><![CDATA[
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
72
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
73 ############ first, create a directory to store all files
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
74 mkdir -p $report.files_path && cd $report.files_path &&
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
75
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
76
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
77 ############ save the tool installation directory to an environment variable
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
78 export TOOL_INSTALL_DIR='${__tool_directory__}' &&
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
79
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
80
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
81 #########################
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
82 ##
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
83 ## save user input option/argument pairs into a file
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
84 ##
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
85 #########################
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
86
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
87 ## first line will be the header
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
88 echo 'type|flag|value|path_type' > options_and_arguments.txt &&
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
89
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
90 ############ tool_name
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
91 ##-t '$tool_name'
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
92 echo "tool_name|not available|${tool_name}|not available" >> options_and_arguments.txt &&
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
93
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
94 ####################################################
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
95 ## loop through repeats to get option/argument pairs
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
96 ####################################################
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
97
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
98 ############ option_argument_single_dataset
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
99 #for i in $option_argument_single_dataset_repeat:
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
100 #set $item = 'single_dataset|' + str($i.flag) + "|" + str($i.value) + "|"
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
101 echo '$item' >> options_and_arguments.txt &&
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
102 #end for
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
103
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
104 ############ option_argument_multiple_datasets
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
105 #for i in $option_argument_multiple_datasets_repeat:
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
106 #set $item = 'multiple_datasets|' + str($i.flag) + "|" + str($i.value).replace(',', str($i.delimiter)) + "|"
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
107 echo '$item' >> options_and_arguments.txt &&
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
108 #end for
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
109
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
110
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
111 ############ option_argument_path_relative_to_a_tool
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
112 #for i in $option_argument_path_relative_to_a_tool_repeat:
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
113 #set $item = 'path_relative_to_a_tool|' + str($i.flag) + "|" + str($i.value) + "|" + str($i.a_tool_output_dir)
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
114 echo '$item' >> options_and_arguments.txt &&
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
115 #end for
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
116
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
117 ############ option_argument_path_relative_to_this_tool
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
118 #for i in $option_argument_path_relative_to_this_tool_repeat:
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
119 #set $item = 'path_relative_to_this_tool|' + str($i.flag) + "|" + str($i.value) + "|" + str($i.path_type)
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
120 echo '$item' >> options_and_arguments.txt &&
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
121 #end for
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
122
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
123 ############ option_argument_string_float_integer
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
124 #for i in $option_argument_string_float_integer_repeat:
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
125 #set $item = 'value|' + str($i.flag) + "|" + str($i.value) + "|"
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
126 echo '$item' >> options_and_arguments.txt &&
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
127 #end for
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
128
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
129 ############ output_set
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
130 ## '$report'
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
131 ## '$report.files_path'
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
132 ## '$tool_help_doc'
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
133 ## '$tool_output_dir'
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
134 ## '$tool_log'
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
135 #######################
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
136 export REPORT='$report' &&
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
137 export REPORT_FILES_PATH='$report.files_path' &&
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
138 export TOOL_HELP_DOC='$tool_help_doc' &&
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
139 export TOOL_OUTPUT_DIR='$tool_output_dir' &&
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
140 export TOOL_LOG='$tool_log' &&
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
141
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
142
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
143 ############ run render R script to render R markdowns
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
144 Rscript '${__tool_directory__}/dynamic_tool_render.R'
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
145
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
146 ]]></command>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
147 </xml>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
148 <!--tool citations-->
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
149 <xml name="citations">
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
150 <citation type="bibtex"><![CDATA[
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
151 @article{allaire2016rmarkdown,
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
152 title={rmarkdown: Dynamic Documents for R, 2016},
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
153 author={Allaire, J and Cheng, Joe and Xie, Yihui and McPherson, Jonathan and Chang, Winston and Allen, Jeff
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
154 and Wickham, Hadley and Atkins, Aron and Hyndman, Rob},
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
155 journal={R package version 0.9},
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
156 volume={6},
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
157 year={2016}
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
158 }
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
159 ]]></citation>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
160 <citation type="bibtex"><![CDATA[
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
161 @book{xie2015dynamic,
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
162 title={Dynamic Documents with R and knitr},
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
163 author={Xie, Yihui},
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
164 volume={29},
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
165 year={2015},
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
166 publisher={CRC Press}
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
167 }
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
168 ]]></citation>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
169 </xml>
4cd5e5e9b030 planemo upload
mingchen0919
parents:
diff changeset
170 </macros>