annotate elastic_r_package_wrappers_macros.xml @ 9:06f38d3febdc draft default tip

planemo upload
author mingchen0919
date Wed, 28 Mar 2018 23:34:03 -0400
parents ea3271940757
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
1 <macros>
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
2
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
3 <xml name="rmarkdown_requirements">
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
4 <requirement type="package" version="1.15.0.6-0">pandoc</requirement>
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
5 <requirement type="package" version="1.6">r-rmarkdown</requirement>
8
ea3271940757 planemo upload
mingchen0919
parents: 7
diff changeset
6 <requirement type="package" version="1.1.1">r-tidyverse</requirement>
0
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
7 </xml>
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
8
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
9 <xml name="stdio">
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
10 <stdio>
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
11 <regex match="XXX" source="stderr" level="warning"
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
12 description="Check the tool log output file for more details."/>
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
13 </stdio>
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
14 </xml>
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
15
6
3de03ccbf8fb planemo upload
mingchen0919
parents: 5
diff changeset
16 <xml name="function_components">
9
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
17 <repeat name="function_components" title="Call a function" min="1" default="1">
8
ea3271940757 planemo upload
mingchen0919
parents: 7
diff changeset
18 <param type="select" name="function_name" multiple="false" label="==== Call function ====">
ea3271940757 planemo upload
mingchen0919
parents: 7
diff changeset
19 <option value="ggplot" selected="false">ggplot</option>
9
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
20 <option value="geom_point" selected="false">geom_point</option>
8
ea3271940757 planemo upload
mingchen0919
parents: 7
diff changeset
21 <option value="aes" selected="false">ggplot</option>
ea3271940757 planemo upload
mingchen0919
parents: 7
diff changeset
22 <option value="read.table" selected="false">read.table</option>
ea3271940757 planemo upload
mingchen0919
parents: 7
diff changeset
23 <option value="write.csv" selected="false">write.csv</option>
ea3271940757 planemo upload
mingchen0919
parents: 7
diff changeset
24 </param>
4
9ec93a1a6139 planemo upload
mingchen0919
parents: 3
diff changeset
25 <expand macro="function_arguments" />
9ec93a1a6139 planemo upload
mingchen0919
parents: 3
diff changeset
26 </repeat>
9ec93a1a6139 planemo upload
mingchen0919
parents: 3
diff changeset
27 </xml>
9ec93a1a6139 planemo upload
mingchen0919
parents: 3
diff changeset
28
0
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
29 <xml name="function_arguments">
9
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
30 <repeat name="function_arguments" title="argument name/value pairs" min="0" default="0">
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
31 <conditional name="argument_type">
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
32 <param name="argument_type_selector" type="select" label="Argument type">
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
33 <option value="value" selected="false">user input value</option>
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
34 <option value="rdata" selected="false">value from RData output</option>
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
35 </param>
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
36 <when value="value">
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
37 <param type="text" name="argument_name" label="argument name" />
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
38 <param type="text" name="argument_value" label="argument value" />
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
39 </when>
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
40 <when value="rdata">
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
41 <param type="text" name="argument_name" label="argument name" />
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
42 <param type="data" format="rdata" name="argument_value" optional="false" label="RData output" />
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
43 </when>
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
44 </conditional>
0
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
45 </repeat>
9
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
46 <param type="select" name="operator" label="connect to next function">
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
47 <sanitizer>
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
48 <valid initial="string.printable"/>
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
49 </sanitizer>
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
50 <option value="%>%" selected="true">pipe (%>%)</option>
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
51 <option value="+" selected="false">plus (+)</option>
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
52 </param>
0
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
53 </xml>
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
54
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
55
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
56 <!--output set-->
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
57 <xml name="output_set">
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
58 <data format="html" name="report" label="${tool.name} report"/>
9
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
59 <data format="rdata" name="tool_rdata_output" label="${tool.name} RData output ${on_string}"/>
0
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
60 <data format="txt" name="tool_log" label="${tool.name} log" />
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
61 </xml>
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
62
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
63
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
64 <!--shell command fragment-->
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
65 <xml name="shell_command">
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
66 <command><![CDATA[
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
67
8
ea3271940757 planemo upload
mingchen0919
parents: 7
diff changeset
68 ############ 1. create a directory to store all files
0
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
69 mkdir -p $report.files_path &&
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
70
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
71
8
ea3271940757 planemo upload
mingchen0919
parents: 7
diff changeset
72 ############ 2. save the tool installation directory to an environment variable
0
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
73 export TOOL_INSTALL_DIR='${__tool_directory__}' &&
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
74
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
75
8
ea3271940757 planemo upload
mingchen0919
parents: 7
diff changeset
76 ############ 3. save user inputs into arguments.txt
0
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
77
8
ea3271940757 planemo upload
mingchen0919
parents: 7
diff changeset
78 ############ 3.1 table header
9
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
79 echo 'row_type|function_name|argument_name|argument_value|argument_value_type|operator' > $report.files_path/arguments.txt &&
0
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
80
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
81
8
ea3271940757 planemo upload
mingchen0919
parents: 7
diff changeset
82 ############ 3.2 loop through function component repeat
9
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
83 #for fun_component in $function_components:
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
84 echo 'func|$fun_component.function_name||||' >> $report.files_path/arguments.txt &&
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
85
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
86 Rscript -e 'library(tidyverse); help($fun_component.function_name)' >> $report.files_path/$fun_component.function_name-help.txt &&
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
87
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
88 #for argument in $fun_component.function_arguments:
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
89 echo 'argument||$argument.argument_type.argument_name|$argument.argument_type.argument_value|$argument.argument_type.argument_type_selector|' >> $report.files_path/arguments.txt &&
8
ea3271940757 planemo upload
mingchen0919
parents: 7
diff changeset
90 #end for
9
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
91 echo 'operator|||||$fun_component.operator' >> $report.files_path/arguments.txt &&
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
92 #end for
0
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
93
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
94 ############ output_set
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
95 ## '$report'
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
96 ## '$report.files_path'
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
97 ## '$tool_help_doc'
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
98 ## '$tool_log'
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
99 #######################
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
100 export REPORT='$report' &&
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
101 export REPORT_FILES_PATH='$report.files_path' &&
9
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
102 export TOOL_RDATA_OUTPUT='$tool_rdata_output' &&
0
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
103 export TOOL_LOG='$tool_log' &&
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
104
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
105
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
106 ############ run render R script to render R markdowns
9
06f38d3febdc planemo upload
mingchen0919
parents: 8
diff changeset
107 Rscript '${__tool_directory__}/elastic_r_package_render.R'
0
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
108
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
109 ]]></command>
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
110 </xml>
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
111
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
112 <!--tool citations-->
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
113 <xml name="citations">
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
114 <citation type="bibtex"><![CDATA[
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
115 @article{allaire2016rmarkdown,
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
116 title={rmarkdown: Dynamic Documents for R, 2016},
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
117 author={Allaire, J and Cheng, Joe and Xie, Yihui and McPherson, Jonathan and Chang, Winston and Allen, Jeff
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
118 and Wickham, Hadley and Atkins, Aron and Hyndman, Rob},
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
119 journal={R package version 0.9},
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
120 volume={6},
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
121 year={2016}
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
122 }
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
123 ]]></citation>
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
124 <citation type="bibtex"><![CDATA[
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
125 @book{xie2015elastic,
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
126 title={Dynamic Documents with R and knitr},
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
127 author={Xie, Yihui},
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
128 volume={29},
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
129 year={2015},
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
130 publisher={CRC Press}
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
131 }
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
132 ]]></citation>
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
133 </xml>
a936b1aff8d3 planemo upload
mingchen0919
parents:
diff changeset
134 </macros>