annotate COBRAxy/docs/tools/marea.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 # MAREA
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
2
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
3 Metabolic Enrichment Analysis and Visualization.
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 MAREA performs statistical comparison of metabolic scores (RAS/RPS) and visualizes results on pathway maps.
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 → Metabolic Reaction Enrichment Analysis**
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
12
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
13 1. Upload RAS/RPS scores and sample class file
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
14 2. Select map and configure statistical parameters
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
15 3. Click **Run tool**
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
16
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
17 ## Command-line console
492
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 marea -input_data scores.tsv \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
21 -input_class classes.csv \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
22 -choice_map ENGRO2 \
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
23 -comparison manyvsmany \
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
24 -pvalue 0.05 \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
25 -idop output/
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
26 ```
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
27
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
28 ## Parameters
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
29
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
30 | Parameter | Flag | Description | Default |
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
31 |-----------|------|-------------|---------|
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
32 | Input Data | `-input_data` | RAS/RPS scores file | - |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
33 | Input Class | `-input_class` | Sample class definitions | - |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
34 | Map Choice | `-choice_map` | ENGRO2, Recon, or Custom | ENGRO2 |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
35 | Custom Map | `-custom_map` | Path to custom SVG map | - |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
36 | Comparison | `-comparison` | manyvsmany, onevsrest, onevsmany | manyvsmany |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
37 | P-value | `-pvalue` | Significance threshold | 0.05 |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
38 | FDR Correction | `-fdr` | Apply FDR correction | true |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
39 | Test Type | `-test_type` | t, wilcoxon, ks, DESeq | t |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
40 | Net RPS | `--net` | Use net contribution for reversible reactions (RPS only) | false |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
41 | Output Path | `-idop` | Output directory | marea/ |
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
42
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
43 ## Input Formats
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
44
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
45 ### Metabolic Scores
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
46
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
47 ```
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
48 Reaction Sample1 Sample2 Sample3
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
49 R00001 1.25 0.85 1.42
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
50 R00002 0.65 1.35 0.72
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
51 ```
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
52
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
53 ### Sample Classes
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
54
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
55 ```
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
56 SampleID Class
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
57 Sample1 Control
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
58 Sample2 Treatment
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
59 Sample3 Treatment
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
60 ```
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
61
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
62 **File Format Notes:**
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
63 - Use **tab-separated** values (TSV) or **comma-separated** (CSV)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
64 - First row must contain column headers
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
65 - Sample names must match between scores and class file
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
66 - Class names should not contain spaces
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
67
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
68 ## Statistical Tests
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
69
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
70 - **t**: Student's t-test (parametric, assumes normality)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
71 - **wilcoxon**: Wilcoxon/Mann-Whitney (non-parametric)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
72 - **ks**: Kolmogorov-Smirnov (distribution-free)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
73 - **DESeq**: DESeq2-like test (**RAS only**, requires ≥2 replicates per sample)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
74
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
75 ## Comparison Types
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
76
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
77 - **manyvsmany**: All pairwise comparisons
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
78 - **onevsrest**: Each class vs all others
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
79 - **onevsmany**: One reference vs multiple classes
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
80
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
81 ## Advanced Options
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
82
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
83 ### Net RPS Values
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
84
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
85 When analyzing RPS data with reversible reactions, the `--net` parameter controls arrow coloring:
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
86
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
87 **When `--net false` (default):**
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
88 - Each direction of a reversible reaction colored independently
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
89 - Forward and backward contributions shown separately
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
90
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
91 **When `--net true` (RPS only):**
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
92 - Arrow tips colored with net contribution of both directions
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
93 - Useful for visualizing overall metabolite flow direction
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
94
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
95 **Note**: This option only applies to RPS analysis and affects visualization of reversible reactions on metabolic maps.
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
96
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
97 ## Output
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
98
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
99 - `*_map.svg`: Annotated pathway maps
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
100 - `comparison_results.tsv`: Statistical results
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
101 - `*.log`: Processing log
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
102
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
103 ## Examples
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
104
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
105 ### Basic Analysis
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
106
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
107 ```bash
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
108 marea -input_data ras_scores.tsv \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
109 -input_class classes.csv \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
110 -choice_map ENGRO2 \
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
111 -comparison manyvsmany \
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
112 -pvalue 0.05 \
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
113 -idop results/
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
114 ```
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
115
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
116 ### Custom Map
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
117
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
118 ```bash
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
119 marea -input_data rps_scores.tsv \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
120 -input_class classes.csv \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
121 -choice_map Custom \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
122 -custom_map pathway.svg \
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
123 -comparison onevsrest \
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
124 -idop results/
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
125 ```
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
126
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
127 ### Non-parametric Test
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
128
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
129 ```bash
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
130 marea -input_data scores.tsv \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
131 -input_class classes.csv \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
132 -choice_map ENGRO2 \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
133 -test_type wilcoxon \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
134 -pvalue 0.01 \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
135 -fdr true \
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
136 -idop results/
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
137 ```
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
138
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
139 ## Troubleshooting
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
140
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
141 | Error | Solution |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
142 |-------|----------|
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
143 | "No matching reactions" | Verify reaction IDs |
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
144 | "Insufficient samples" | Increase sample sizes per group |
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
145
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
146 ## See Also
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
147
547
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
148 - [RAS Generator](tools/ras-generator)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
149 - [RPS Generator](tools/rps-generator)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
150 - [Flux to Map](tools/flux-to-map)
73f2f7e2be17 Uploaded
francesco_lapi
parents: 542
diff changeset
151 - [Built-in Models](reference/built-in-models)