Skip to content
Snippets Groups Projects
README.md 1.03 KiB
Newer Older
Juliette Cooke's avatar
Juliette Cooke committed
# SAMBA
## Description
SAMpling Biomarker Analysis is a toolset for running flux sampling on metabolic networks, predicting biomarkers 
(or metabolic profiles), and representing the results visually.
Juliette Cooke's avatar
Juliette Cooke committed

## Visuals
[add example plots here]
Juliette Cooke's avatar
Juliette Cooke committed

## Getting started
### Requirements
#### SAMBApy
- Python 3.7+
- cobrapy
- A solver (GLPK, CPLEX, GUROBI)
- Access to a computer cluster or powerful computer
#### SAMBAr
- R
- ggplot2

### Installation
Juliette Cooke's avatar
Juliette Cooke committed
Install via pip:  

```bash
pip install sambapy
```
Juliette Cooke's avatar
Juliette Cooke committed

## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of 
usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
Juliette Cooke's avatar
Juliette Cooke committed

Juliette Cooke's avatar
Juliette Cooke committed
## Confirmed working models

Juliette Cooke's avatar
Juliette Cooke committed
## Roadmap
- [x] Add support for multiple KOs at once
- [ ] Add the option to reduce flux rates in addition to KO
## Authors
Juliette Cooke
Juliette Cooke's avatar
Juliette Cooke committed

## Acknowledgments
Juliette Cooke's avatar
Juliette Cooke committed


## License
MIT License (see LICENSE file)
Juliette Cooke's avatar
Juliette Cooke committed

## Project status
Currently active on this project.