annotate dynamic_tool_wrappers_macros.xml @ 1:ddc3c3527f49 draft

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