annotate COBRAxy/docs/README.md @ 546:01147e83f43c draft default tip

Uploaded
author luca_milaz
date Mon, 27 Oct 2025 12:33:08 +0000
parents fcdbc81feb45
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
1 # COBRAxy Documentation
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
2
542
fcdbc81feb45 Uploaded
francesco_lapi
parents: 538
diff changeset
3 > A Python-based command-line suite for metabolic flux analysis and visualization, with Galaxy integration.
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
4
542
fcdbc81feb45 Uploaded
francesco_lapi
parents: 538
diff changeset
5 COBRAxy enables the integration of transcriptomics data with COBRA-based metabolic models, offering a comprehensive framework for studying metabolism in both health and disease. With COBRAxy, users can load and enrich metabolic models by incorporating transcriptomic data and adjusting the model's medium conditions.
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
6
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
7 ## Overview
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
8
538
fd53d42348bd Uploaded
francesco_lapi
parents: 492
diff changeset
9 COBRAxy enables constraint-based modeling and sampling techniques, allowing users to compute metabolic
fd53d42348bd Uploaded
francesco_lapi
parents: 492
diff changeset
10 flux distributions for multiple biological samples. The tool also enables the integration of medium
fd53d42348bd Uploaded
francesco_lapi
parents: 492
diff changeset
11 composition information to refine flux predictions. Additionally, COBRAxy provides a user-friendly interface
fd53d42348bd Uploaded
francesco_lapi
parents: 492
diff changeset
12 for visualizing significant flux differences between populations on an enriched metabolic map. This
fd53d42348bd Uploaded
francesco_lapi
parents: 492
diff changeset
13 extension provides a comprehensive and accessible framework for advanced metabolic analysis, enabling
fd53d42348bd Uploaded
francesco_lapi
parents: 492
diff changeset
14 researchers without extensive programming expertise to explore complex metabolic processes
fd53d42348bd Uploaded
francesco_lapi
parents: 492
diff changeset
15
fd53d42348bd Uploaded
francesco_lapi
parents: 492
diff changeset
16 By offering an intuitive and accessible platform for multi-omics integration and metabolic analysis, COBRAxy meets the growing need for tools that help researchers explore complex metabolic processes with ease.
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
17
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
18 ## Key Features
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
19
538
fd53d42348bd Uploaded
francesco_lapi
parents: 492
diff changeset
20 - **Galaxy Tools** - Web-based analysis with intuitive interface
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
21 - **Reaction Activity Scores (RAS)** - Compute metabolic activity from gene expression data
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
22 - **Reaction Propensity Scores (RPS)** - Infer metabolic preferences from metabolite abundance
538
fd53d42348bd Uploaded
francesco_lapi
parents: 492
diff changeset
23 - **Flux computation** - Compute metabolic flux distributions using different optimization or sampling algorithms
fd53d42348bd Uploaded
francesco_lapi
parents: 492
diff changeset
24 - **Statistical Analysis** - Perform statistically significant flux differences between groups of samples and report on an enriched metabolic map
fd53d42348bd Uploaded
francesco_lapi
parents: 492
diff changeset
25 - **Built-in Models** - Ready-to-use models including ENGRO2 and Recon3D
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
26
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
27 ## Quick Navigation
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
28
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
29 ### [Installation](installation.md)
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
30 Install COBRAxy and get it running on your system
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
31
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
32 ### [Tutorials](tutorials/)
542
fcdbc81feb45 Uploaded
francesco_lapi
parents: 538
diff changeset
33 Step-by-step guides for Galaxy usage
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
34
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
35 ### [Tools Documentation](tools/)
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
36 Complete reference for all COBRAxy tools
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
37
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
38 ## Data Flow
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
39
542
fcdbc81feb45 Uploaded
francesco_lapi
parents: 538
diff changeset
40 COBRAxy supports three main analysis workflows:
fcdbc81feb45 Uploaded
francesco_lapi
parents: 538
diff changeset
41
fcdbc81feb45 Uploaded
francesco_lapi
parents: 538
diff changeset
42 1. **RAS-based Enrichment Analysis**:
fcdbc81feb45 Uploaded
francesco_lapi
parents: 538
diff changeset
43 Gene Expression → RAS Generation → MAREA → Enriched Pathway Maps
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
44
542
fcdbc81feb45 Uploaded
francesco_lapi
parents: 538
diff changeset
45 2. **Flux Sampling Analysis**:
fcdbc81feb45 Uploaded
francesco_lapi
parents: 538
diff changeset
46 Gene Expression → RAS Generation → RAS to Bounds → Flux Simulation → Flux to Map → Flux-enriched Maps
fcdbc81feb45 Uploaded
francesco_lapi
parents: 538
diff changeset
47
fcdbc81feb45 Uploaded
francesco_lapi
parents: 538
diff changeset
48 3. **RAS+RPS Combined Enrichment**:
fcdbc81feb45 Uploaded
francesco_lapi
parents: 538
diff changeset
49 Gene Expression + Metabolite Data → RAS + RPS Generation → MAREA → Multi-omics Enriched Maps
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
50
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
51 ## Community & Support
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
52
542
fcdbc81feb45 Uploaded
francesco_lapi
parents: 538
diff changeset
53 - **Documentation**: Complete guides and references
fcdbc81feb45 Uploaded
francesco_lapi
parents: 538
diff changeset
54 - **Issues**: Report bugs and request features on [GitHub](https://github.com/CompBtBs/COBRAxy/issues)
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
55 - **Contributing**: Help improve COBRAxy
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
56
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
57 **Ready to start?** Follow the [Installation Guide](installation.md) to get COBRAxy up and running!