annotate COBRAxy/custom_data_generator.xml @ 6:deb6d3439342 draft

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