annotate elastic_tool.xml @ 5:a2e5852d96ba draft default tip

planemo upload
author mingchen0919
date Sun, 01 Apr 2018 22:24:12 -0400
parents e2b68db3177c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
1 <tool id="elastic_fastq_dump" name="elastic fastq-dump" version="1.0.1">
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
2 <macros>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
3 <import>elastic_tool_macros.xml</import>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
4 </macros>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
5 <expand macro="tool_description"/>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
6 <requirements>
3
9f61c75f17b7 planemo upload
mingchen0919
parents: 1
diff changeset
7 <expand macro="tool_requirements"/>
1
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
8 </requirements>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
9 <stdio>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
10 <regex match="XXX" source="stderr" level="warning"
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
11 description="Check the tool log output file for more details."/>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
12 </stdio>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
13 <command><![CDATA[
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
14
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
15 ############ first, create a directory to store all files
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
16 mkdir -p $report.files_path &&
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
17
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
18
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
19 ############ save the tool installation directory to an environment variable
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
20 export TOOL_INSTALL_DIR='${__tool_directory__}' &&
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
21
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
22
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
23 #########################
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
24 ##
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
25 ## save user input option/argument pairs into a file
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
26 ##
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
27 #########################
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
28
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
29 ## first line will be the header
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
30 echo 'type|option|value|path_type' > $report.files_path/options_and_arguments.txt &&
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
31
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
32 ############ tool_name
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
33 ##-t '$tool_name'
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
34 echo "tool_name|not available|${tool_name}|not available" >> $report.files_path/options_and_arguments.txt &&
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
35
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
36 ####################################################
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
37 ## loop through repeats to get option/argument pairs
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
38 ####################################################
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
39
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
40 ############ option_argument_single_dataset
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
41 #for i in $option_argument_single_dataset_repeat:
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
42 #set $item = 'single_dataset|' + str($i.option) + "|" + str($i.value) + "|"
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
43 echo '$item' >> $report.files_path/options_and_arguments.txt &&
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
44 #end for
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
45
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
46 ############ option_argument_multiple_datasets
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
47 #for i in $option_argument_multiple_datasets_repeat:
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
48 #set $item = 'multiple_datasets|' + str($i.option) + "|" + str($i.value).replace(',', str($i.delimiter)) + "|"
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
49 echo '$item' >> $report.files_path/options_and_arguments.txt &&
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
50 #end for
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
51
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
52
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
53 ############ option_argument_path_relative_to_a_tool
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
54 #for i in $option_argument_path_relative_to_a_tool_repeat:
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
55 #set $item = 'path_relative_to_a_tool|' + str($i.option) + "|" + str($i.value) + "|" + str($i.a_tool_output_dir)
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
56 echo '$item' >> $report.files_path/options_and_arguments.txt &&
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
57 #end for
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
58
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
59 ############ option_argument_path_relative_to_this_tool
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
60 #for i in $option_argument_path_relative_to_this_tool_repeat:
5
a2e5852d96ba planemo upload
mingchen0919
parents: 4
diff changeset
61 #set $item = 'path_relative_to_this_tool|' + str($i.option) + "|" + $report.files_path + '/' + str($i.value) + "|" + str($i.path_type)
1
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
62 echo '$item' >> $report.files_path/options_and_arguments.txt &&
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
63 #end for
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
64
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
65 ############ option_argument_string_float_integer
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
66 #for i in $option_argument_string_float_integer_repeat:
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
67 #set $item = 'value|' + str($i.option) + "|" + str($i.value) + "|"
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
68 echo '$item' >> $report.files_path/options_and_arguments.txt &&
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
69 #end for
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
70
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
71 ############ output_set
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
72 ## '$report'
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
73 ## '$report.files_path'
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
74 ## '$tool_output_dir'
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
75 ## '$tool_log'
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
76 #######################
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
77 export REPORT='$report' &&
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
78 export REPORT_FILES_PATH='$report.files_path' &&
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
79 export TOOL_OUTPUT_DIR='$tool_output_dir' &&
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
80 export TOOL_LOG='$tool_log' &&
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
81
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
82
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
83 ############ run render R script to render R markdowns
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
84 Rscript '${__tool_directory__}/elastic_tool_render.R'
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
85
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
86 ]]></command>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
87 <inputs>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
88 <param type="select" name="tool_name" multiple="false" label="Tool name">
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
89 <expand macro="tool_options"/>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
90 </param>
4
e2b68db3177c planemo upload
mingchen0919
parents: 3
diff changeset
91 <repeat name="option_argument_single_dataset_repeat" title="DATA FROM HISTORY: single data set" min="0"
1
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
92 default="0">
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
93 <param type="text" name="option" optional="true" label="option"/>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
94 <param name="value" type="data" optional="false" multiple="false" label="value"/>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
95 </repeat>
4
e2b68db3177c planemo upload
mingchen0919
parents: 3
diff changeset
96 <repeat name="option_argument_multiple_datasets_repeat" title="DATA FROM HISTORY: multiple data sets"
1
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
97 min="0" default="0">
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
98 <param type="text" name="option" optional="true" label="option"/>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
99 <param name="value" type="data" optional="false" multiple="true" label="value"/>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
100 <param type="select" name="delimiter" multiple="false" label="file delimiter">
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
101 <option value=" " selected="false">space</option>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
102 <option value="," selected="false">comma</option>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
103 </param>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
104 </repeat>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
105 <repeat name="option_argument_path_relative_to_a_tool_repeat"
4
e2b68db3177c planemo upload
mingchen0919
parents: 3
diff changeset
106 title="DATA PATH: relative to other tool output directory" min="0" default="0">
1
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
107 <param type="text" name="option" optional="true" label="option"/>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
108 <param name="a_tool_output_dir" type="data" optional="false" multiple="false"
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
109 label="a tool output directory"/>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
110 <param type="text" name="value" optional="true" label="value"/>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
111 </repeat>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
112 <repeat name="option_argument_path_relative_to_this_tool_repeat"
4
e2b68db3177c planemo upload
mingchen0919
parents: 3
diff changeset
113 title="DATA PATH: relative to this tool output directory" min="0" default="0">
1
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
114 <param type="text" name="option" optional="true" label="option"/>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
115 <param type="text" name="value" optional="false" label="value"/>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
116 <param type="select" name="path_type" multiple="false" label="path type">
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
117 <option value="file_path" selected="false">file path</option>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
118 <option value="dir_path" selected="false">directory path</option>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
119 </param>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
120 </repeat>
4
e2b68db3177c planemo upload
mingchen0919
parents: 3
diff changeset
121 <repeat name="option_argument_string_float_integer_repeat" title="INPUT VALUE: string/float/integer" min="0"
e2b68db3177c planemo upload
mingchen0919
parents: 3
diff changeset
122 default="0">
e2b68db3177c planemo upload
mingchen0919
parents: 3
diff changeset
123 <param type="text" name="option" label="option"/>
e2b68db3177c planemo upload
mingchen0919
parents: 3
diff changeset
124 <param type="text" name="value" label="value"/>
e2b68db3177c planemo upload
mingchen0919
parents: 3
diff changeset
125 </repeat>
1
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
126 </inputs>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
127 <outputs>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
128 <data format="html" name="report" label="${tool.name} report ${on_string}"/>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
129 <data format="txt" name="tool_output_dir" label="${tool.name} output directory ${on_string}"/>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
130 <data format="txt" name="tool_log" label="${tool.name} log ${on_string}"/>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
131 </outputs>
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
132 <citations>
4
e2b68db3177c planemo upload
mingchen0919
parents: 3
diff changeset
133 <expand macro="citations"/>
1
1aeef205e648 planemo upload
mingchen0919
parents: 0
diff changeset
134 </citations>
0
28ce9fcb06c7 planemo upload
mingchen0919
parents:
diff changeset
135 </tool>