annotate elastic_tool_wrappers_macros.xml @ 0:b503fbd571a6 draft default tip

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