comparison COBRAxy/docs/README.md @ 492:4ed95023af20 draft

Uploaded
author francesco_lapi
date Tue, 30 Sep 2025 14:02:17 +0000
parents
children fd53d42348bd
comparison
equal deleted inserted replaced
491:7a413a5ec566 492:4ed95023af20
1 # COBRAxy Documentation
2
3 > A Python toolkit for metabolic flux analysis and visualization, with Galaxy integration.
4
5 COBRAxy transforms gene expression and metabolite data into meaningful metabolic insights through flux sampling and interactive pathway maps.
6
7 ## Overview
8
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.
10
11 ## Key Features
12
13 - **Reaction Activity Scores (RAS)** - Compute metabolic activity from gene expression data
14 - **Reaction Propensity Scores (RPS)** - Infer metabolic preferences from metabolite abundance
15 - **Flux Sampling** - Sample metabolic flux distributions with CBS or OptGP algorithms
16 - **Statistical Analysis** - Perform pFBA, FVA, and sensitivity analysis
17 - **Interactive Maps** - Generate publication-ready pathway visualizations with SVG/PDF export
18 - **Galaxy Tools** - Web-based analysis with intuitive interface
19 - **Built-in Models** - Ready-to-use models including ENGRO2 and Recon
20
21 ## Quick Navigation
22
23 ### [Installation](installation.md)
24 Install COBRAxy and get it running on your system
25
26 ### [Tutorials](tutorials/)
27 Step-by-step guides for Galaxy and Python usage
28
29 ### [Tools Documentation](tools/)
30 Complete reference for all COBRAxy tools
31
32 ## Data Flow
33
34 COBRAxy follows two parallel analysis paths:
35
36 1. **Enrichment Analysis**: RAS + RPS → MAREA → Enriched Maps
37 2. **Flux Simulation**: RAS → Model Constraints → Flux Sampling → Flux Maps
38
39 ## Community & Support
40
41 - **Documentation**: Complete guides and API reference
42 - **Discussions**: Ask questions and share experiences
43 - **Issues**: Report bugs and request features
44 - **Contributing**: Help improve COBRAxy
45
46 ## Quick Links
47
48 | Resource | Description |
49 |----------|-------------|
50 | [Installation Guide](installation.md) | Get COBRAxy running on your system |
51 | [Galaxy Tutorial](tutorials/galaxy-setup.md) | Web-based analysis setup |
52 | [Python Tutorial](tutorials/python-api.md) | Use COBRAxy programmatically |
53 | [Tools Documentation](tools/) | Complete tool reference |
54
55 ---
56
57 **Ready to start?** Follow the [Installation Guide](installation.md) to get COBRAxy up and running!