annotate xlsx2tab.xml @ 1:bcd7b59c1251 draft default tip

Uploaded
author ylebras
date Mon, 03 Dec 2018 16:23:41 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
1 <tool id="xlsx2tab_R" name="XLSX sheet to Tabular" version="0.1">
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
2 <requirements>
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
3 <requirement type="package" version="3.2.1">R</requirement>
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
4 <requirement type="package" version="1.1.0">r-readxl</requirement>
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
5 </requirements>
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
6 <command detect_errors="exit_code"><![CDATA[
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
7 Rscript '$__tool_directory__/xlsx2tab.R' '$input1' '$sheet' '$output' ]]>
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
8 </command>
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
9 <inputs>
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
10 <param format="xlsx" name="input1" type="data" label="XLSX file"/>
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
11 <param name="sheet" type="text" label="Excel sheet name" value="biodiv_data">
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
12 <sanitizer sanitize="False"/>
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
13 </param>
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
14
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
15 </inputs>
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
16
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
17 <outputs>
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
18 <data format="tabular" name="output" from_work_dir="out.tabular" />
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
19 </outputs>
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
20
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
21 <tests>
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
22 <test>
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
23 <param name="input1" value="example_csv.csv"/>
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
24 <param name="sheet" value=","/>
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
25 <output name="output" file="out.tabular"/>
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
26 </test>
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
27 </tests>
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
28
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
29 <help>
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
30 **What it does**
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
31
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
32 Extract a sheet from XLSX file to a tabular file.
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
33
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
34
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
35 ------
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
36
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
37 **Example**
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
38
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
39 Input XLSX sheet
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
40
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
41
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
42
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
43 Output tabular :
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
44
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
45 "John" "Smith" "2 mySteet, myCity"
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
46
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
47 "François" "LeFrançais" "1 rue du Général, Paris"
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
48
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
49 "Other" "Random" "Stuff, stuff, stuff"
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
50
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
51 ------
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
52
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
53 **Arguments**
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
54
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
55 Input : xlsx file.
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
56
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
57
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
58
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
59
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
60 </help>
bcd7b59c1251 Uploaded
ylebras
parents:
diff changeset
61 </tool>