annotate custom_data_generator.xml @ 283:813439d60f85 draft

Uploaded
author luca_milaz
date Mon, 08 Jul 2024 22:18:11 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
283
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
1 <tool id="MaREA Custom Data Generator" name="CustomDataGenerator" version="1.0.0">
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
2 <description>- Custom Data Generator for RAS and RPS modules</description>
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
3 <macros>
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
4 <import>marea_macros.xml</import>
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
5 </macros>
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
6 <requirements>
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
7
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
8 </requirements>
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
9 <command detect_errors="exit_code">
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
10 <![CDATA[
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
11 python $__tool_directory__/custom_data_generator.py
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
12 --input $input
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
13 --name $input.element_identifier
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
14 --output_format $output_format
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
15 --out_log $log
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
16 ]]>
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
17 </command>
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
18 <inputs>
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
19 <param name="input" argument="--input" type="data" format="xml, json" label="Custom model:" />
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
20 <param name="name" argument="--name" type="text" label="Model's name:" value="Model" help="Default: Model" />
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
21
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
22 <param name="output_format" argument="--output_format" type="select" label="Output files format:">
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
23 <option value="p" selected="true">pickle extension (binary, non-editable, pre-parsed)</option>
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
24 <option value="csv">Comma Separated Values (csv text file, editable, raw)</option>
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
25 </param>
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
26 </inputs>
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
27
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
28 <outputs>
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
29 <data format="txt" name="log" label="CustomDataGenerator - $name - Log" />
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
30
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
31 <collection name="results" type="list" label="Custom Data Results ($output_format)">
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
32 <discover_datasets name = "collection" pattern="__name_and_ext__" directory="result"/>
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
33 </collection>
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
34 </outputs>
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
35
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
36 <help>
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
37 <![CDATA[
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
38 What it does
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
39 -------------
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
40
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
41 This tool generates two files containing reactions and rules respectively, starting from a custom model in JSON or XML format, that can be used as inputs for the RAS and RPS generator modules.
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
42
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
43 Accepted files:
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
44 - A model: JSON or XML file reporting reactions and rules contained in the model.
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
45
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
46
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
47 Output:
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
48 -------------
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
49
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
50 The tool generates:
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
51 - rules: reporting the rules for each reaction in the custom model given. Format: csv or pickle.
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
52 - reactions: reporting the reactions in the custom model given. Format: csv or pickle.
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
53 - a log file (.txt).
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
54 ]]>
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
55 </help>
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
56 <expand macro="citations" />
813439d60f85 Uploaded
luca_milaz
parents:
diff changeset
57 </tool>