annotate COBRAxy/docs/README.md @ 509:5956dcf94277 draft default tip

Uploaded
author francesco_lapi
date Wed, 01 Oct 2025 15:34:21 +0000
parents 4ed95023af20
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
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
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
5 COBRAxy transforms gene expression and metabolite data into meaningful metabolic insights through flux sampling and interactive pathway maps.
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
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
9 COBRAxy provides a complete pipeline for metabolic modeling and analysis, from raw omics data to publication-ready pathway visualizations. Whether you're a researcher analyzing metabolic changes in disease, a systems biologist studying metabolic networks, or a bioinformatician building analysis pipelines, COBRAxy offers the tools you need.
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
10
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
11 ## Key Features
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
12
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
13 - **Reaction Activity Scores (RAS)** - Compute metabolic activity from gene expression data
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
14 - **Reaction Propensity Scores (RPS)** - Infer metabolic preferences from metabolite abundance
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
15 - **Flux Sampling** - Sample metabolic flux distributions with CBS or OptGP algorithms
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
16 - **Statistical Analysis** - Perform pFBA, FVA, and sensitivity analysis
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
17 - **Interactive Maps** - Generate publication-ready pathway visualizations with SVG/PDF export
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
18 - **Galaxy Tools** - Web-based analysis with intuitive interface
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
19 - **Built-in Models** - Ready-to-use models including ENGRO2 and Recon
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
20
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
21 ## Quick Navigation
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
22
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
23 ### [Installation](installation.md)
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
24 Install COBRAxy and get it running on your system
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
25
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
26 ### [Tutorials](tutorials/)
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
27 Step-by-step guides for Galaxy and Python usage
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
28
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
29 ### [Tools Documentation](tools/)
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
30 Complete reference for all COBRAxy tools
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
31
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
32 ## Data Flow
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
33
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
34 COBRAxy follows two parallel analysis paths:
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
35
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
36 1. **Enrichment Analysis**: RAS + RPS → MAREA → Enriched Maps
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
37 2. **Flux Simulation**: RAS → Model Constraints → Flux Sampling → Flux Maps
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
38
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
39 ## Community & Support
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
40
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
41 - **Documentation**: Complete guides and API reference
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
42 - **Discussions**: Ask questions and share experiences
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
43 - **Issues**: Report bugs and request features
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
44 - **Contributing**: Help improve COBRAxy
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
45
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
46 ## Quick Links
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
47
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
48 | Resource | Description |
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
49 |----------|-------------|
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
50 | [Installation Guide](installation.md) | Get COBRAxy running on your system |
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
51 | [Galaxy Tutorial](tutorials/galaxy-setup.md) | Web-based analysis setup |
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
52 | [Python Tutorial](tutorials/python-api.md) | Use COBRAxy programmatically |
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
53 | [Tools Documentation](tools/) | Complete tool reference |
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
54
4ed95023af20 Uploaded
francesco_lapi
parents:
diff changeset
55 ---
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!