https://github.com/vini2/reneo
🦠🧬 Unraveling Viral Genomes from Metagenomes
https://github.com/vini2/reneo
assembly-graphs bioinformatics metagenomics viruses
Last synced: about 2 months ago
JSON representation
🦠🧬 Unraveling Viral Genomes from Metagenomes
- Host: GitHub
- URL: https://github.com/vini2/reneo
- Owner: Vini2
- License: mit
- Created: 2023-03-27T06:09:40.000Z (over 2 years ago)
- Default Branch: develop
- Last Pushed: 2024-09-23T05:03:58.000Z (about 1 year ago)
- Last Synced: 2025-07-09T00:57:31.146Z (3 months ago)
- Topics: assembly-graphs, bioinformatics, metagenomics, viruses
- Language: Python
- Homepage:
- Size: 25.3 MB
- Stars: 10
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Reneo: Unraveling Viral Genomes from Metagenomes
===============
[](https://zenodo.org/badge/latestdoi/619432085)
[](https://github.com/beardymcjohnface/Snaketool)
[](http://bioconda.github.io/recipes/reneo/README.html)
[](https://anaconda.org/bioconda/reneo)
[](https://anaconda.org/bioconda/reneo)
[](https://badge.fury.io/py/reneo)
[](https://github.com/psf/black)
[](https://github.com/Vini2/reneo/actions/workflows/test_reneo.yml)
[](https://github.com/Vini2/reneo/actions/workflows/codeql.yml)
[Reneo](https://en.wiktionary.org/wiki/reneo) means to *unravel* or *untangle* in Latin. Reneo is a software developed to unravel or untangle high-quality genomes from viral communities (including both prokaryotic and eukaryotic viruses) found within metagenomes using assembly graphs. Reneo identifies viral components in the metagenomic assembly using virus orthologous groups from [VOGDB](https://vogdb.org/), models as flow networks and solves a minimum flow decomposition (MFD) problem to resolve genomic paths. Reneo was motivated based on a bacteriophage recovery tool named [Phables](https://github.com/Vini2/phables), specifically to extend the capabilities of Phables to all viruses.
**NEW:** Reneo is available on Bioconda at [https://anaconda.org/bioconda/reneo](https://anaconda.org/bioconda/reneo) and on PyPI at [https://pypi.org/project/reneo](https://pypi.org/project/reneo).
## Setting up Reneo
### Option 1: Installing Reneo using conda (recommended)
You can install Reneo from bioconda at [https://anaconda.org/bioconda/reneo](https://anaconda.org/bioconda/reneo). Make sure you have [`conda`](https://docs.conda.io/en/latest/) installed.
```bash
# create conda environment and install reneo
conda create -n reneo -c conda-forge -c anaconda -c bioconda reneo
# activate environment
conda activate reneo
```
Now you can go to [Setting up Gurobi](#setting-up-gurobi) to configure Gurobi.
### Option 2: Installing Reneo using pip
You can install Reneo from PyPI at [https://pypi.org/project/phables/](https://pypi.org/project/reneo/). Make sure you have [`pip`](https://pip.pypa.io/en/stable/) and [`mamba`](https://mamba.readthedocs.io/en/latest/index.html) installed.
```bash
pip install reneo
```
Now you can go to [Setting up Gurobi](#setting-up-gurobi) to configure Gurobi.
### Setting up Gurobi
The MFD implementation uses the linear programming solver [Gurobi](https://www.gurobi.com/). The `reneo` conda environment does not include Gurobi. You have to install Gurobi using the following command.
```bash
conda install -c gurobi gurobi
```
To handle large models without any model size limitations, once you have installed Gurobi, you have to activate the (academic) license and add the key using the following command. You only have to do this once.
```bash
grbgetkey
```
You can refer to further instructions at [https://www.gurobi.com/academia/academic-program-and-licenses/](https://www.gurobi.com/academia/academic-program-and-licenses/).
## Quick Start Guide
### Setting up databases
Run the following command to download and set up the databases used in Reneo.
```bash
reneo install
```
### Testing the setup
After setting up, run the following command to print out the Reneo help message.
```bash
reneo --help
```
You can simulate a Reneo run using the following command.
```bash
reneo simulate
```
You can also run Reneo with the test dataset provided.
```bash
reneo test
```
### Running Reneo
```bash
# Run Reneo
# locally: using 16 threads (default is 8 threads)
reneo run --input assembly_graph.gfa --reads fastq/ --threads 16
```
## Issues and Questions
Reneo is still under testing. Please report any issues and suggestions under [Reneo Issues](https://github.com/Vini2/reneo/issues).
## Acknowledgement
Reneo uses the [Gurobi](https://www.gurobi.com/) implementation of [MFD-ILP](https://github.com/algbio/MFD-ILP) and code snippets from [Phables](https://github.com/Vini2/phables/). The Reneo logo was designed by [Laura Inglis](https://fame.flinders.edu.au/people/2021/01/01/laura-inglis).
## Citation
Reneo is a work in progress and the manuscript is currently in preparation. In the meantime, please cite Reneo as
```
V Mallawaarachchi, MJ Roach, LK Inglis and RA Edwards (2023). Reneo: Unraveling Viral Genomes from Metagenomes. Available at https://github.com/Vini2/reneo DOI: 10.5281/zenodo.8263066
```