An open API service indexing awesome lists of open source software.

https://github.com/leooojr/divv

Differential Investigation of Variability in Variants
https://github.com/leooojr/divv

bioinformatics python variant-analysis variant-calling variants vcf vcf-comparison

Last synced: 26 days ago
JSON representation

Differential Investigation of Variability in Variants

Awesome Lists containing this project

README

          

# DIVV


![Static Badge](https://img.shields.io/badge/python-3.10%2B-yellow?label=python&labelColor=grey&color=yellow)
![Static Badge](https://img.shields.io/badge/htslib-1.21-grey?color=brightgreen)
![GitHub last commit](https://img.shields.io/github/last-commit/LeoooJR/DIVV)

## :bookmark_tabs: Table of Contents
- [About](#about)
- [Getting Started](#getting-started)
- [Contacts](#contacts)

## :pencil: About The Project


DIVV is a software tool designed for comparing two VCF files that have been generated from panel sequencing.

It leverages the CyVCF2 library, which is actively maintained, providing superior VCF file parsing compared to PyVCF. Additionally, tasks are parallelized to enhance efficiency. Moreover, a dynamic report is generated, offering users an optimized and user-friendly visualization of the results.

## :rocket: Getting Started

```bash
# Clone the repository
git clone https://github.com/LeoooJR/DIVV.git

# Changed directory to the cloned repository
cd DIVV
```

### :computer: Local installation

```bash
# Compile htslib
./install.sh ./src

# Get help about DIVV
python src/main.py --help

# Compare VCF files
python src/main.py --vcfs --report --output
```

### :whale2: Using docker

```bash
# Build the image
docker build -t divv .

# Run the container
docker run --rm divv --vcfs --report --output

# Get help about DIVV
docker run --rm divv --help
```

## 🗨️ Contacts

For questions, feel free to reach out to the maintainers through GitHub or connect on LinkedIn.

[Back to top](#top)