annotate rdata_extractor.xml @ 1:5184899fd06e draft default tip

Uploaded
author mnhn65mo
date Tue, 07 Aug 2018 08:23:15 -0400
parents 10212598b005
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
1 <tool id="Rdata_exctract" name="Rdata parser" version="0.1">
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
2 <requirements>
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
3 <requirement type="package" version="1.20.0">r-getopt</requirement>
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
4 <requirement type="package" version="7.0">readline</requirement>
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
5 </requirements>
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
6 <command detect_errors="exit_code"><![CDATA[
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
7 mkdir outputs &&
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
8 Rscript '$__tool_directory__/rdata_extractor.R' '$rdata' $selectedattributes '$summary' '$other' '$bind_dataframe'
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
9 ]]>
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
10 </command>
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
11 <inputs>
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
12 <param name="rdata" type="data" label="Rdata file to explore" format="rdata"/>
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
13 <param name="rdata_attributes" type="data" label="File with .Rdata content details" format="tabular"/>
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
14
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
15 <param name="selectedattributes" label="Select which attribute(s) you want to extract" type="select" display="checkboxes" multiple="true">
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
16 <options from_dataset="rdata_attributes">
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
17 <column name="value" index="0"/>
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
18 </options>
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
19 </param>
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
20 <param name="bind_dataframe" label="Bind variables in a single tabular when its possible" type="boolean" truevalue="bind" falsevalue="nobind" checked="true"/>
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
21 </inputs>
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
22 <outputs>
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
23 <data name="summary" from_work_dir="summary.tabular" format="tabular" label="Summary"/>
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
24 <data name="other">
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
25 <discover_datasets pattern="__designation_and_ext__" visible="true" directory="outputs"/>
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
26 </data>
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
27 </outputs>
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
28 <help><![CDATA[
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
29
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
30 .. class:: infomark
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
31
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
32 ==========================
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
33 Rdata parser
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
34 ==========================
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
35 **What it does**
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
36
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
37
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
38 The Rdata parser tool allows to extract informations from a binary R file in .RData format.
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
39
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
40
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
41 It produces a summary file and extract the selected dimensions.
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
42
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
43 More informations concerning R Data format and save / load functions can be found here: http://www.sthda.com/english/wiki/saving-data-into-r-data-format-rds-and-rdata&gt.
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
44
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
45 More informations concerning R Data format and save / load functions can be found here: http://www.sthda.com/english/wiki/saving-data-into-r-data-format-rds-and-rdata&gt.
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
46
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
47
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
48 |
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
49
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
50 **How to use it**
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
51
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
52 First use the Rdata reader tool to get the list of dimensions available in the binary file.
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
53
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
54 Use the reader tool output to select the dimension(s) you want to extract.
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
55
1
5184899fd06e Uploaded
mnhn65mo
parents: 0
diff changeset
56 If the selected variables can be displayed alongside in a tabular files the option \"Bind\" will try to do so.
5184899fd06e Uploaded
mnhn65mo
parents: 0
diff changeset
57
0
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
58 ]]></help>
10212598b005 Uploaded
mnhn65mo
parents:
diff changeset
59 </tool>