annotate COBRAxy/docs/tools/ras-generator.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 Generator
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
2
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
3 Compute Reaction Activity Scores (RAS) from gene expression data.
492
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 Generator computes reaction activity scores by evaluating GPR rules with gene expression values.
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 → Expression2RAS**
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
12
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
13 1. Select built-in model or upload custom GPR rules
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
14 2. Upload gene expression data
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
15 3. Click **Run tool**
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
16
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
17 ## Command-line console
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
18
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
19 ```bash
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
20 ras_generator -rs ENGRO2 \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
21 -in expression_data.tsv \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
22 -ra ras_scores.tsv \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
23 -ol ras_generation.log
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
24 ```
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
25
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
26 ## Parameters
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
27
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
28 | Parameter | Flag | Description | Default |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
29 |-----------|------|-------------|---------|
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
30 | Rules Selector | `-rs` | ENGRO2, Recon, or Custom | ENGRO2 |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
31 | Input Data | `-in` | Gene expression TSV file | - |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
32 | Output RAS | `-ra` | Output RAS scores file | - |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
33 | Output Log | `-ol` | Log file | - |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
34 | Custom Rules | `-rl` | Custom GPR rules file | - |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
35 | Gene Names | `-gn` | Gene ID type | HGNC_Symbol |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
36 | Remove Gene | `-rg` | Remove missing genes | true |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
37 | Ignore NaN | `--none` | Handle missing gene expression | true |
542
fcdbc81feb45 Uploaded
francesco_lapi
parents: 538
diff changeset
38
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
39 ## Input Format
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
40
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
41 Gene expression file (TSV):
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 Gene Sample1 Sample2 Sample3
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
45 ALDOA 125.5 98.3 142.7
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
46 ENO1 85.2 110.4 95.8
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
47 PFKM 200.3 185.6 210.1
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 (Gene, Sample names)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
53 - Gene names must match the selected gene ID type
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
54 - Numeric values only for expression data
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
55
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
56 ## GPR Rules
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
57
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
58 - **AND**: All genes required
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
59 - **OR**: Any gene sufficient
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
60 - Example: `(GENE1 and GENE2) or GENE3`
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
61
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
62 ## NaN Handling
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
63
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
64 The `--none` parameter controls how missing gene expression values are treated in GPR rules:
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
65
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
66 **When `--none true` (default):**
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
67 - `(GENE1 and NaN)` → evaluated as `GENE1` value
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
68 - `(GENE1 or NaN)` → evaluated as `GENE1` value
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
69 - Missing genes don't block reaction activity calculation
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
70
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
71 **When `--none false` (strict mode):**
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
72 - `(GENE1 and NaN)` → `NaN` (reaction cannot be evaluated)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
73 - `(GENE1 or NaN)` → `NaN` (reaction cannot be evaluated)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
74 - Any missing gene propagates NaN through the entire GPR expression
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
75
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
76 **Recommendation**: Use default (`true`) for datasets with incomplete gene coverage.
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
77
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
78 ## Output Format
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
79
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
80 ```
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
81 Reaction Sample1 Sample2 Sample3
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
82 R00001 125.5 98.3 142.7
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
83 R00002 85.2 110.4 95.8
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
84 ```
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
85
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
86 ## Examples
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
87
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
88 ### Basic Usage
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
89
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
90 ```bash
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
91 ras_generator -rs ENGRO2 \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
92 -in expression.tsv \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
93 -ra ras_scores.tsv
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
94 ```
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
95
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
96 ## Troubleshooting
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
97
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
98 | Error | Solution |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
99 |-------|----------|
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
100 | "Gene not found" | Check gene ID format |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
101 | "Invalid GPR" | Verify GPR rule syntax |
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
102
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
103 ## See Also
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
104
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
105 - [RAS to Bounds](tools/ras-to-bounds)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
106 - [MAREA](tools/marea)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
107 - [Built-in Models](reference/built-in-models)