annotate COBRAxy/docs/tools/rps-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 # RPS Generator
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
2
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
3 Compute Reaction Presence Scores (RPS) from metabolite abundance 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: 492
diff changeset
7 RPS Generator calculates reaction presence scores based on metabolite availability in reaction formulas.
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
8
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
9 ## Galaxy Interface
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
10
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
11 In Galaxy: **COBRAxy → RPS Generator**
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
12
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
13 1. Select built-in model or upload custom reactions
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
14 2. Upload metabolite abundance data
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
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: 492
diff changeset
20 rps_generator -rs ENGRO2 \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
21 -in metabolite_data.tsv \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
22 -rps rps_scores.tsv \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
23 -ol rps_generation.log
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
24 ```
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
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
28 | Parameter | Flag | Description | Default |
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
29 |-----------|------|-------------|---------|
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
30 | Rules Selector | `-rs` | ENGRO2, Recon, or Custom | ENGRO2 |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
31 | Input Data | `-in` | Metabolite abundance TSV file | - |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
32 | Output RPS | `-rps` | Output RPS scores file | - |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
33 | Output Log | `-ol` | Log file | - |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
34 | Custom Rules | `-rl` | Custom reaction formulas file | - |
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
35
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
36 ## Input Format
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
37
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
38 Metabolite data file (TSV):
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
39
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
40 ```
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
41 Metabolite Sample1 Sample2 Sample3
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
42 glc_c 2.5 1.8 3.2
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
43 atp_c 5.2 4.9 5.8
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
44 pyr_c 1.5 2.1 1.8
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
45 ```
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
46
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
47 **File Format Notes:**
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
48 - Use **tab-separated** values (TSV)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
49 - First row must contain column headers (Metabolite, Sample names)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
50 - Metabolite names must include compartment suffix (e.g., _c, _m, _e)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
51 - Numeric values only for abundance data
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
52
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
53 ## Output Format
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
54
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
55 ```
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
56 Reaction Sample1 Sample2 Sample3
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
57 R00001 1.25 0.95 1.42
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
58 R00002 0.85 1.15 0.92
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
59 ```
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
60
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
61 ## Examples
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
62
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
63 ### Basic Usage
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
64
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
65 ```bash
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
66 rps_generator -rs ENGRO2 \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
67 -in metabolites.tsv \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
68 -rps rps_scores.tsv
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
69 ```
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
70
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
71 ### Custom Reactions
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
72
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
73 ```bash
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
74 rps_generator -rs Custom \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
75 -rl custom_reactions.csv \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
76 -in metabolites.tsv \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
77 -rps rps_scores.tsv
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
78 ```
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
79
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
80 ## Troubleshooting
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
81
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
82 | Error | Solution |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
83 |-------|----------|
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
84 | "Metabolite not found" | Check metabolite nomenclature |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
85 | "Invalid formula" | Verify reaction formula syntax |
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
86
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
87 ## See Also
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
88
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
89 - [MAREA](tools/marea)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
90 - [RAS Generator](tools/ras-generator)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 492
diff changeset
91 - [Built-in Models](reference/built-in-models)