Skip to content

About

Antiviral resistance analysis framework for any virus

Resources

Stars

3 stars

Watchers

0 watching

Forks

Repository files navigation

Simplify your antiviral resistance genotyping with

ResistanceProfiler

WebApp (Online and Free - hosted by us):

ResPro Monitoring

Command-line tool (available via docker and bioconda):

License: AGPL-3.0 Supported Python versions codecov Conda Update Conda version Conda downloads

What is ResPro?

It's a pathogen-agnostic antiviral resistance profiling engine that allows resistance database creation for any virus and antiviral. Next generation sequencing and sanger derieved sequencing results can profiled against this database. By design a module. Plug it into your existing viral reconstruction pipeline.

Tip

Built your own database. Its really simple.

One harmonized report that classifies mutations and assists diagnostic interpretation against curated project databases. Comes as a CLI or a WebApp. Everything is open-source. Contributions are welcome!

Highlights

  • Framework for genotypic antiviral resistance analysis — not limited to a single pathogen
  • Get auto-curated project databases with built-in QC and reference normalization
  • Amino-acid-centered rule matching with combination-rule support (AND, OR, NOT, XOR)
  • Pre-ported maintained databases available via respro databases --download
  • CLI-first design for workflow integration; companion WebApp for interactive use
  • Deterministic report regeneration from stored results

Quick start

Install the CLI via conda (recommended):

conda create -n respro -c conda-forge -c bioconda respro
conda activate respro

Install via Docker (BioContainers):

docker pull quay.io/biocontainers/respro

Install via pip:

git clone https://github.com/the-foxlab/ResistanceProfiler
cd ResistanceProfiler
pip install -e .

Download a maintained database (e.g. herpesDRG):

respro databases --list
respro databases --download herpesdrg --output my_folder/

Profile:

respro fasta --project my_folder/herpesdrg.db --fasta sample.fasta --output results/

or

respro vcf --project my_folder/herpesdrg.db --vcf sample.vcf --ref-fasta ref.fasta --output results/

→ Full guide: Installation · Quickstart · CLI Reference

WebApp (host it yourself!)

git clone https://github.com/the-foxlab/ResistanceProfiler
docker compose -f docker-compose.web.yml up --build

Open at http://127.0.0.1:8000/

Prefer the prebuilt CI image (no local build)? It's published to GHCR on every push to master:

docker pull ghcr.io/the-foxlab/resistanceprofiler:latest

See the webapp docs for pulling a specific tag, authenticated pulls for private packages, and the egress requirements for a server that fetches images at runtime.

→ Web app documentation

License

AGPL v3.0 — source code only. External databases and references may carry separate licenses.

About

Antiviral resistance analysis framework for any virus

Resources

Stars

3 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages