annotate COBRAxy/tabular2MetabolicModel.xml @ 516:7726a4a7173f draft

Uploaded
author luca_milaz
date Thu, 09 Oct 2025 09:32:41 +0000
parents df90f40a156c
children fd53d42348bd
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
491
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
1 <tool id="tabular2MetabolicModel" name="tabular2MetabolicModel" version="1.0.0">
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
2 <description>Convert a tabular dataset to a COBRA model</description>
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
3
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
4 <!-- Python dependencies required for COBRApy -->
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
5 <requirements>
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
6 <requirement type="package" version="0.29.0">cobra</requirement>
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
7 <requirement type="package" version="1.24.4">numpy</requirement>
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
8 <requirement type="package" version="2.0.3">pandas</requirement>
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
9 <requirement type="package" version="5.2.2">lxml</requirement>
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
10 </requirements>
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
11
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
12 <!-- Import shared macros if available -->
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
13 <macros>
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
14 <import>marea_macros.xml</import>
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
15 </macros>
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
16
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
17 <!-- Command to run the Python script -->
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
18 <command detect_errors="exit_code"><![CDATA[
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
19 python $__tool_directory__/tabular2MetabolicModel.py
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
20 --tool_dir $__tool_directory__
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
21 --input $input
498
df90f40a156c Uploaded
francesco_lapi
parents: 491
diff changeset
22 --format $format
491
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
23 --output $output
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
24 --out_log $log
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
25 ]]></command>
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
26
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
27 <!-- Tool inputs -->
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
28 <inputs>
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
29 <param name="input" type="data" format="tabular,csv,tsv" label="Input table"/>
498
df90f40a156c Uploaded
francesco_lapi
parents: 491
diff changeset
30 <param name="model_name" type="text" value="Converted_Model" label="Model name" help="Name for the created COBRA model"/>
491
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
31 <param name="format" type="select" label="Output COBRA model format">
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
32 <option value="sbml" selected="true">SBML (.xml)</option>
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
33 <option value="json">JSON (.json)</option>
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
34 <option value="mat">MATLAB (.mat)</option>
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
35 <option value="yaml">YAML (.yml)</option>
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
36 </param>
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
37 </inputs>
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
38
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
39 <!-- Tool outputs -->
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
40 <outputs>
498
df90f40a156c Uploaded
francesco_lapi
parents: 491
diff changeset
41 <data name="log" format="txt" label="Tabular to Model Conversion - Log" />
df90f40a156c Uploaded
francesco_lapi
parents: 491
diff changeset
42 <data name="output" format="xml" label="${model_name}.${format}">
491
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
43 <change_format>
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
44 <when input="format" value="sbml" format="xml"/>
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
45 <when input="format" value="json" format="json"/>
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
46 <when input="format" value="mat" format="mat"/>
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
47 <when input="format" value="yaml" format="yaml"/>
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
48 </change_format>
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
49 </data>
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
50 </outputs>
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
51
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
52 <!-- Help section -->
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
53 <help><![CDATA[
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
54 This tool converts a tabular dataset into a COBRA model using COBRApy.
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
55
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
56 **Input**
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
57 - A tabular/CSV/TSV file describing reactions, metabolites, or stoichiometry.
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
58
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
59 **Output**
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
60 - A COBRA model in the chosen format:
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
61 - SBML (.xml)
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
62 - JSON (.json)
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
63 - MATLAB (.mat)
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
64 - YAML (.yml)
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
65
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
66 **Notes**
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
67 - The exact table structure (columns required) depends on how you want to encode reactions and metabolites.
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
68 - You can extend the Python script to parse specific column formats.
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
69 ]]></help>
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
70 </tool>