annotate COBRAxy/docs/README.md @ 538:fd53d42348bd draft

Uploaded
author francesco_lapi
date Sat, 25 Oct 2025 11:39:03 +0000
parents 4ed95023af20
children fcdbc81feb45
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
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
3 > A Python toolkit for metabolic flux analysis and visualization, with Galaxy integration.
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
4
538
fd53d42348bd Uploaded
francesco_lapi
parents: 492
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/)
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
33 Step-by-step guides for Galaxy and Python usage
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
538
fd53d42348bd Uploaded
francesco_lapi
parents: 492
diff changeset
40 COBRAxy follows several analysis paths:
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
41
538
fd53d42348bd Uploaded
francesco_lapi
parents: 492
diff changeset
42 1. **RAS Enrichment Analysis**: RAS computation → MAREA → Enriched Maps
fd53d42348bd Uploaded
francesco_lapi
parents: 492
diff changeset
43 2. **Flux Enrichment Analysis Simulation**: RAS computation → Model Constraints → Flux Sampling → Flux Maps
fd53d42348bd Uploaded
francesco_lapi
parents: 492
diff changeset
44 3. **RAS/RPS Enrichment Analysis**: RAS + RPS computation → MAREA → Enriched Maps
492
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
45
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
46 ## Community & Support
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
47
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
48 - **Documentation**: Complete guides and API reference
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
49 - **Discussions**: Ask questions and share experiences
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
50 - **Issues**: Report bugs and request features
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
51 - **Contributing**: Help improve COBRAxy
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
52
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
53 ## Quick Links
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
54
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
55 | Resource | Description |
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
56 |----------|-------------|
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
57 | [Installation Guide](installation.md) | Get COBRAxy running on your system |
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
58 | [Galaxy Tutorial](tutorials/galaxy-setup.md) | Web-based analysis setup |
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
59 | [Python Tutorial](tutorials/python-api.md) | Use COBRAxy programmatically |
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
60 | [Tools Documentation](tools/) | Complete tool reference |
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
61
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
62 ---
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
63
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
64 **Ready to start?** Follow the [Installation Guide](installation.md) to get COBRAxy up and running!