annotate elastic_tool_wrappers_macros.xml @ 1:16e0f4b7a286 draft

planemo upload commit d255df0b70677f4d5e5f2f8e240ce0b69f40d69d
author mingchen0919
date Mon, 26 Mar 2018 18:40:39 -0400
parents a163532ab267
children 391394c022b8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
1 <?xml version="1.0" encoding="UTF-8"?>
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
2 <macros>
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
3 <xml name="rmarkdown_requirements">
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
4 <requirement type="package" version="1.15.0.6-0">pandoc</requirement>
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
5 <requirement type="package" version="1.6">r-rmarkdown</requirement>
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
6 </xml>
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
7 <xml name="stdio">
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
8 <stdio>
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
9 <regex match="XXX" source="stderr" level="warning" description="Check the tool log output file for more details."/>
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
10 </stdio>
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
11 </xml>
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
12 <!--OPTION/ARGUMENT PAIRS and INPUT types-->
1
16e0f4b7a286 planemo upload commit d255df0b70677f4d5e5f2f8e240ce0b69f40d69d
mingchen0919
parents: 0
diff changeset
13
0
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
14 <!--input path-->
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
15 <xml name="option_argument_path_relative_to_a_tool">
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
16 <repeat name="option_argument_path_relative_to_a_tool_repeat" title="INPUT DATA PATH: relative to a tool output directory" min="0" default="0">
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
17 <param name="a_tool_output_dir" type="data" optional="false" multiple="false" label="a tool output directory"/>
1
16e0f4b7a286 planemo upload commit d255df0b70677f4d5e5f2f8e240ce0b69f40d69d
mingchen0919
parents: 0
diff changeset
18 <param type="text" name="value" optional="true" label="relative path"/>
0
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
19 </repeat>
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
20 </xml>
1
16e0f4b7a286 planemo upload commit d255df0b70677f4d5e5f2f8e240ce0b69f40d69d
mingchen0919
parents: 0
diff changeset
21
0
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
22 <!--shell command fragment-->
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
23 <xml name="shell_command">
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
24 <command><![CDATA[
1
16e0f4b7a286 planemo upload commit d255df0b70677f4d5e5f2f8e240ce0b69f40d69d
mingchen0919
parents: 0
diff changeset
25 echo $tool_name &&
0
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
26
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
27 ############ first, create a directory to store all files
1
16e0f4b7a286 planemo upload commit d255df0b70677f4d5e5f2f8e240ce0b69f40d69d
mingchen0919
parents: 0
diff changeset
28 mkdir -p $report.files_path &&
0
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
29
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
30
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
31 ############ save the tool installation directory to an environment variable
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
32 export TOOL_INSTALL_DIR='${__tool_directory__}' &&
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
33
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
34
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
35 #########################
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
36 ##
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
37 ## save user input option/argument pairs into a file
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
38 ##
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
39 #########################
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
40
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
41 ## first line will be the header
1
16e0f4b7a286 planemo upload commit d255df0b70677f4d5e5f2f8e240ce0b69f40d69d
mingchen0919
parents: 0
diff changeset
42 echo 'tool_output_dir|relative_path' > '$report.files_path/options_and_arguments.txt' &&
0
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
43
1
16e0f4b7a286 planemo upload commit d255df0b70677f4d5e5f2f8e240ce0b69f40d69d
mingchen0919
parents: 0
diff changeset
44
0
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
45
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
46 ####################################################
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
47 ## loop through repeats to get option/argument pairs
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
48 ####################################################
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
49
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
50
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
51 ############ option_argument_path_relative_to_a_tool
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
52 #for i in $option_argument_path_relative_to_a_tool_repeat:
1
16e0f4b7a286 planemo upload commit d255df0b70677f4d5e5f2f8e240ce0b69f40d69d
mingchen0919
parents: 0
diff changeset
53 #set $item = str($i.a_tool_output_dir) + "|" + str($i.value)
16e0f4b7a286 planemo upload commit d255df0b70677f4d5e5f2f8e240ce0b69f40d69d
mingchen0919
parents: 0
diff changeset
54 echo '$item' >> '$report.files_path/options_and_arguments.txt' &&
0
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
55 #end for
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
56
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
57
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
58 ############ output_set
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
59 ## '$report'
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
60 ## '$report.files_path'
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
61 #######################
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
62 export REPORT='$report' &&
1
16e0f4b7a286 planemo upload commit d255df0b70677f4d5e5f2f8e240ce0b69f40d69d
mingchen0919
parents: 0
diff changeset
63 export TOOL_LOG='$tool_log' &&
0
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
64 export REPORT_FILES_PATH='$report.files_path' &&
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
65
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
66
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
67 ############ run render R script to render R markdowns
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
68 Rscript '${__tool_directory__}/elastic_tool_render.R'
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
69
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
70 ]]></command>
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
71 </xml>
1
16e0f4b7a286 planemo upload commit d255df0b70677f4d5e5f2f8e240ce0b69f40d69d
mingchen0919
parents: 0
diff changeset
72
16e0f4b7a286 planemo upload commit d255df0b70677f4d5e5f2f8e240ce0b69f40d69d
mingchen0919
parents: 0
diff changeset
73 <!--<xml name="output_set">-->
16e0f4b7a286 planemo upload commit d255df0b70677f4d5e5f2f8e240ce0b69f40d69d
mingchen0919
parents: 0
diff changeset
74 <!--<data format="html" name="report" label="${tool.name} report"/>-->
16e0f4b7a286 planemo upload commit d255df0b70677f4d5e5f2f8e240ce0b69f40d69d
mingchen0919
parents: 0
diff changeset
75 <!--<data format="txt" name="tool_log" label="${tool.name} log"/>-->
16e0f4b7a286 planemo upload commit d255df0b70677f4d5e5f2f8e240ce0b69f40d69d
mingchen0919
parents: 0
diff changeset
76 <!--<collection type="list" name="list_collection">-->
16e0f4b7a286 planemo upload commit d255df0b70677f4d5e5f2f8e240ce0b69f40d69d
mingchen0919
parents: 0
diff changeset
77 <!--<discover_datasets pattern="__name_and_ext__" directory="list" />-->
16e0f4b7a286 planemo upload commit d255df0b70677f4d5e5f2f8e240ce0b69f40d69d
mingchen0919
parents: 0
diff changeset
78 <!--</collection>-->
16e0f4b7a286 planemo upload commit d255df0b70677f4d5e5f2f8e240ce0b69f40d69d
mingchen0919
parents: 0
diff changeset
79 <!--<collection type="paired" name="list_collection">-->
16e0f4b7a286 planemo upload commit d255df0b70677f4d5e5f2f8e240ce0b69f40d69d
mingchen0919
parents: 0
diff changeset
80 <!--<discover_datasets pattern="__name_and_ext__" directory="paired_dir" />-->
16e0f4b7a286 planemo upload commit d255df0b70677f4d5e5f2f8e240ce0b69f40d69d
mingchen0919
parents: 0
diff changeset
81 <!--</collection>-->
16e0f4b7a286 planemo upload commit d255df0b70677f4d5e5f2f8e240ce0b69f40d69d
mingchen0919
parents: 0
diff changeset
82 <!--<collection type="list:paired" name="list_collection">-->
16e0f4b7a286 planemo upload commit d255df0b70677f4d5e5f2f8e240ce0b69f40d69d
mingchen0919
parents: 0
diff changeset
83 <!--<discover_datasets pattern="(?P&lt;identifier_0&gt;[^_]+)_(?P&lt;identifier_1&gt;[^_]+)\.(?P&lt;ext&gt;[^\._]+)?"-->
16e0f4b7a286 planemo upload commit d255df0b70677f4d5e5f2f8e240ce0b69f40d69d
mingchen0919
parents: 0
diff changeset
84 <!--directory="list_paired"/>-->
16e0f4b7a286 planemo upload commit d255df0b70677f4d5e5f2f8e240ce0b69f40d69d
mingchen0919
parents: 0
diff changeset
85 <!--</collection>-->
16e0f4b7a286 planemo upload commit d255df0b70677f4d5e5f2f8e240ce0b69f40d69d
mingchen0919
parents: 0
diff changeset
86 <!--</xml>-->
16e0f4b7a286 planemo upload commit d255df0b70677f4d5e5f2f8e240ce0b69f40d69d
mingchen0919
parents: 0
diff changeset
87
0
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
88 <!--tool citations-->
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
89 <xml name="citations">
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
90 <citation type="bibtex"><![CDATA[
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
91 @article{allaire2016rmarkdown,
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
92 title={rmarkdown: Dynamic Documents for R, 2016},
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
93 author={Allaire, J and Cheng, Joe and Xie, Yihui and McPherson, Jonathan and Chang, Winston and Allen, Jeff
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
94 and Wickham, Hadley and Atkins, Aron and Hyndman, Rob},
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
95 journal={R package version 0.9},
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
96 volume={6},
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
97 year={2016}
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
98 }
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
99 ]]></citation>
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
100 <citation type="bibtex"><![CDATA[
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
101 @book{xie2015elastic,
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
102 title={Dynamic Documents with R and knitr},
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
103 author={Xie, Yihui},
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
104 volume={29},
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
105 year={2015},
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
106 publisher={CRC Press}
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
107 }
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
108 ]]></citation>
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
109 </xml>
a163532ab267 planemo upload
mingchen0919
parents:
diff changeset
110 </macros>