annotate COBRAxy/docs/tools/import-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 # Import Metabolic Model
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
2
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
3 Import and extract metabolic model components into tabular format.
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 Import Metabolic Model extracts metabolic models from SBML/JSON/MAT/YAML formats into tabular summary for analysis.
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
8
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
9 **Input**: Model file or built-in models
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
10 **Output**: Tabular data (CSV/TSV)
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 → Import Metabolic Model**
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
15
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
16 1. Select built-in model or upload custom file
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
17 2. Set model name and medium configuration
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 # Import built-in model
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
24 importMetabolicModel \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
25 --model ENGRO2 \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
26 --name ENGRO2 \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
27 --medium_selector allOpen \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
28 --out_tabular model_data.csv \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
29 --out_log extraction.log
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
30 ```
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
31
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
32 ## Parameters
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
33
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
34 ### Model Selection
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
35
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
36 | Parameter | Flag | Description |
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
37 |-----------|------|-------------|
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
38 | Built-in Model | `--model` | ENGRO2 or Recon |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
39 | Custom Model | `--input` | Path to SBML/JSON/MAT/YAML file |
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
40
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
41 **Note**: Use either `--model` OR `--input`.
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
42
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
43
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
44 ### Required
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
45
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
46 | Parameter | Flag | Description |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
47 |-----------|------|-------------|
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
48 | Model Name | `--name` | Model identifier |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
49 | Medium Selector | `--medium_selector` | Medium configuration (use `allOpen`) |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
50 | Output Tabular | `--out_tabular` | Output file (CSV/XLSX) |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
51 | Output Log | `--out_log` | Log file |
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
52
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
53 ### Optional
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
54
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
55 | Parameter | Flag | Description | Default |
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
56 |-----------|------|-------------|---------|
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
57 | Custom Medium | `--custom_medium` | CSV file with medium constraints | - |
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
58 | Gene Format | `--gene_format` | Gene ID conversion: Default, ENSG, HGNC_ID, entrez_id | Default |
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
59
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
60 ## Built-in Models
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
61
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
62 - **ENGRO2**: ~500 reactions (recommended)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
63 - **Recon**: ~10,000 reactions (genome-wide)
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
64
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
65 See [Built-in Models](reference/built-in-models) for details.
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
66
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
67 ## Supported Formats
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
68
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
69 - **Model formats**: SBML (.xml), JSON (.json), MAT (.mat), YAML (.yml)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
70 - **Compression**: .zip, .gz, .bz2 (e.g., `model.xml.gz`)
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
71
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
72 Compressed files are automatically detected and extracted.
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
73
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
74 ## Output Format
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
75
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
76 **ENGRO2 model:**
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
77 ```
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
78 ReactionID Formula GPR lower_bound upper_bound ObjectiveCoefficient Pathway_1 Pathway_2 InMedium TranslationIssues
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
79 R00001 A + B -> C + D GENE1 or GENE2 -1000.0 1000.0 0.0 Glycolysis Central_Metabolism FALSE
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
80 EX_glc_e glc_e <-> - -1000.0 1000.0 0.0 Exchange Transport TRUE
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
81 ```
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
82
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
83 **Other models (Recon):**
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
84 ```
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
85 ReactionID Formula GPR lower_bound upper_bound ObjectiveCoefficient InMedium TranslationIssues
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
86 R00001 A + B -> C + D GENE1 or GENE2 -1000.0 1000.0 0.0 FALSE
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
87 EX_glc_e glc_e <-> - -1000.0 1000.0 0.0 TRUE
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
88 ```
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
89
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
90 **File Format Notes:**
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
91 - Output can be **tab-separated** (CSV) or Excel (XLSX)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
92 - Contains all model information in tabular format
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
93 - Can be edited and re-imported using Export Metabolic Model
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
94
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
95 ## Understanding Medium Composition
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
96
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
97 Exchange reactions with `InMedium = TRUE` represent nutrients in the medium:
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
98 - **Lower bound**: Uptake rate (negative value, e.g., -10 = uptake 10 mmol/gDW/hr)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
99 - **Upper bound**: Secretion rate (positive value)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
100
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
101 Example:
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
102 ```
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
103 EX_glc_e glc_e <-> - -10.0 1000.0 0.0 TRUE
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
104 ```
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
105 Glucose uptake: 10 mmol/gDW/hr (lower bound = -10)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
106
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
107 More info: [COBRApy Media Documentation](https://cobrapy.readthedocs.io/en/latest/media.html)
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
108
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
109 ## Examples
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
110
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
111 ### Extract Built-in Model
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
112
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
113 ```bash
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
114 importMetabolicModel --model ENGRO2 \
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
115 --name ENGRO2_extraction \
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
116 --medium_selector allOpen \
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
117 --out_tabular ENGRO2_data.csv \
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
118 --out_log ENGRO2_log.txt
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
119 ```
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
120
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
121 ### Process Custom Model
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
122
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
123 ```bash
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
124 importMetabolicModel --input custom_model.xml \
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
125 --name CustomModel \
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
126 --medium_selector allOpen \
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
127 --out_tabular custom_data.csv \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
128 --out_log custom_log.txt
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
129 ```
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
130
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
131 ## Troubleshooting
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
132
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
133 | Error | Solution |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
134 |-------|----------|
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
135 | "Model file not found" | Check file path |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
136 | "Unsupported format" | Use SBML, JSON, MAT, or YAML |
542
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
137
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
138 ## See Also
fcdbc81feb45 Uploaded
francesco_lapi
parents:
diff changeset
139
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
140 - [Export Metabolic Model](reference/export-metabolic-model)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
141 - [RAS Generator](tools/ras-generator)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
142 - [RPS Generator](tools/rps-generator)