annotate COBRAxy/docs/tools/export-metabolic-model.md @ 548:5aef7b860706 draft default tip

Uploaded
author francesco_lapi
date Tue, 28 Oct 2025 11:04:40 +0000
parents 73f2f7e2be17
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
1 # Export Metabolic Model
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
2
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
3 Convert tabular data into COBRA metabolic model.
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
4
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
5 ## Overview
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
6
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
7 Export Metabolic Model converts structured tabular data (CSV/TSV) into functional COBRA models in SBML, JSON, MATLAB, or YAML formats.
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
8
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
9 **Input**: Tabular model data (CSV/TSV)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
10 **Output**: SBML/JSON/MAT/YAML model files
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
11
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
12 ## Galaxy Interface
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
13
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
14 In Galaxy: **COBRAxy → Export Metabolic Model**
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
15
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
16 1. Upload tabular model data file
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
17 2. Select output format (SBML/JSON/MAT/YAML)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
18 3. Click **Run tool**
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
19
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
20 ## Command-line console
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
21
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
22 ```bash
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
23 exportMetabolicModel \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
24 --input model_data.csv \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
25 --format sbml \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
26 --output custom_model.xml \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
27 --out_log conversion.log
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
28 ```
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
29
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
30 ## Parameters
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
31
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
32 | Parameter | Flag | Description |
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
33 |-----------|------|-------------|
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
34 | Input File | `--input` | Tabular file (CSV/TSV) with model data |
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
35 | Output Format | `--format` | Model format: sbml, json, mat, yaml |
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
36 | Output File | `--output` | Output model file path |
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
37 | Output Log | `--out_log` | Log file |
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
38
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
39 ## Input Format
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
40
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
41 Required columns:
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
42
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
43 ```csv
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
44 ReactionID,Formula,GPR,lower_bound,upper_bound,ObjectiveCoefficient,InMedium,TranslationIssues
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
45 R00001,A + B -> C + D,GENE1 or GENE2,-1000.0,1000.0,0.0,FALSE,
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
46 EX_glc_e,glc_e <->,-,-1000.0,1000.0,0.0,TRUE,
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
47 ```
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
48
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
49 **File Format Notes:**
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
50 - Use **comma-separated** (CSV) or **tab-separated** (TSV)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
51 - First row must contain column headers
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
52 - Required columns: ReactionID, Formula, lower_bound, upper_bound
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
53 - Optional columns: GPR, ObjectiveCoefficient, InMedium, Pathway_1, Pathway_2
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
54
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
55 ## Reaction Formula Syntax
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
56
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
57 ```
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
58 # Irreversible
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
59 A + B -> C + D
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
60
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
61 # Reversible
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
62 A + B <-> C + D
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
63
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
64 # With stoichiometry
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
65 2 A + 3 B -> 1 C + 4 D
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
66 ```
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
67
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
68 ## GPR Rule Syntax
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
69
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
70 ```
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
71 # Single gene
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
72 GENE1
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
73
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
74 # Alternative genes (OR)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
75 GENE1 or GENE2
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
76
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
77 # Required complex (AND)
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
78 GENE1 and GENE2
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
79
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
80 # Nested logic
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
81 (GENE1 and GENE2) or GENE3
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
82 ```
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
83
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
84 ## Output Formats
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
85
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
86 - **SBML**: XML standard, maximum compatibility
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
87 - **JSON**: COBRApy native format
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
88 - **MATLAB**: COBRA Toolbox compatibility
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
89 - **YAML**: Human-readable format
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
90
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
91 ## Examples
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
92
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
93 ### Basic Export
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
94
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
95 ```bash
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
96 exportMetabolicModel --input model.csv \
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
97 --format sbml \
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
98 --output model.xml \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
99 --out_log conversion.log
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
100 ```
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
101
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
102 ## Troubleshooting
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
103
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
104 | Error | Solution |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
105 |-------|----------|
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
106 | "Formula parsing failed" | Check reaction formula syntax |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
107 | "Model infeasible" | Review bounds and exchange reactions |
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
108
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
109 ## See Also
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
110
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
111 - [Import Metabolic Model](reference/import-metabolic-model)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
112 - [RAS to Bounds](tools/ras-to-bounds)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
113 - [Flux Simulation](tools/flux-simulation)