annotate COBRAxy/docs/tools/ras-to-bounds.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
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
1 # RAS to Bounds
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
2
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
3 Apply Reaction Activity Scores (RAS) as constraints to metabolic model bounds.
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
4
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
5 ## Overview
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
6
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
7 RAS to Bounds integrates RAS values into metabolic model flux bounds, creating sample-specific constrained models.
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
8
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
9 ## Galaxy Interface
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
10
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
11 In Galaxy: **COBRAxy → RAS to Bounds**
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
12
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
13 1. Select model and upload RAS scores file
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
14 2. Configure medium and constraint options
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
15 3. Click **Execute**
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
16
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
17 ## Usage
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
18
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
19 ```bash
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
20 ras_to_bounds -ms ENGRO2 \
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
21 -ir ras_scores.tsv \
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
22 -rs true \
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
23 -mes allOpen \
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
24 -idop constrained_bounds/
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
25 ```
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
26
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
27 ## Parameters
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
28
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
29 | Parameter | Flag | Description | Default |
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
30 |-----------|------|-------------|---------|
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
31 | Model Selector | `-ms` | ENGRO2, Recon, or Custom | ENGRO2 |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
32 | RAS Input | `-ir` | RAS scores TSV file | - |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
33 | RAS Selector | `-rs` | Enable RAS constraints | false |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
34 | Medium Selector | `-mes` | Medium configuration | allOpen |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
35 | Save Models | `--save_models` | Save complete models with bounds | false |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
36 | Output Path | `-idop` | Output directory | ras_to_bounds/ |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
37 | Custom Model | `-mo` | Path to custom SBML model | - |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
38 | Custom Medium | `-meo` | Custom medium file | - |
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
39
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
40 ## Input Format
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
41
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
42 RAS scores file (TSV):
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
43
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
44 ```
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
45 Reaction Sample1 Sample2 Sample3
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
46 R00001 1.25 0.85 1.42
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
47 R00002 0.65 1.35 0.72
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
48 ```
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
49
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
50 **File Format Notes:**
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
51 - Use **tab-separated** values (TSV)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
52 - First row must contain column headers (Reaction, Sample names)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
53 - Reaction IDs must match model reaction IDs
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
54 - Numeric values for RAS scores
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
55
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
56 ## Output Format
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
57
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
58 Bounds files for each sample:
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
59
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
60 ```
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
61 reaction lower_bound upper_bound
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
62 R00001 -125.0 125.0
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
63 R00002 -65.0 65.0
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
64 ```
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
65
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
66 ## Output Collections
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
67
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
68 The tool generates three types of output:
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
69
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
70 1. **Bounds files** (`ras_to_bounds/`): Individual bound files per sample (TSV format)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
71 2. **Cell classes** (`cell_class`): Sample-to-class mapping file
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
72 3. **Complete models** (optional, `saved_models/`): Full tabular models with bounds applied
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
73
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
74 To save complete models with integrated bounds, set `--save_models true`. This creates ready-to-use model files that can be directly used with Flux Simulation or other downstream tools.
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
75
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
76 ## Examples
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
77
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
78 ### Basic Usage
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
79
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
80 ```bash
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
81 ras_to_bounds -ms ENGRO2 \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
82 -ir ras_scores.tsv \
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
83 -rs true \
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
84 -idop output/
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
85 ```
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
86
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
87 ### With Custom Model
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
88
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
89 ```bash
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
90 ras_to_bounds -ms Custom \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
91 -mo custom_model.xml \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
92 -ir ras_scores.tsv \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
93 -rs true \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
94 -idop output/
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
95 ```
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
96
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
97 ## Troubleshooting
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
98
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
99 | Error | Solution |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
100 |-------|----------|
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
101 | "Model not found" | Check model file path |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
102 | "RAS file invalid" | Verify TSV format |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
103 | "Infeasible solution" | Relax RAS scaling or constraints |
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
104
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
105 ## See Also
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
106
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
107 - [RAS Generator](tools/ras-generator)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
108 - [Flux Simulation](tools/flux-simulation)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
109 - [Built-in Models](reference/built-in-models)