Skip to content

AlignDx platform for pathogen detection/surveillance from user-uploaded sequencing data and other data types

License

Notifications You must be signed in to change notification settings

doxeylab/aligndx

Repository files navigation


Logo

The Bioinformatics Surveillance Platform

Report Bug | Request Feature

DEMO SERVER

Table of Contents
  1. About The Project
  2. Getting Started
  3. License
  4. Contact
  5. Acknowledgments

About The Project

AlignDx is a web-first platform for running automated bioinformatic workflows for pathogen detection/surveillance. The core of the platform is a dynamic workflow system, that generates pipelines and their respective web-forms based on a collection of schemas. Supporting this is authentication, archiving and task queueing, to deliver a seamless experience.

In the sequencing-based workflow, the user uploads one or more sequencing datasets (.fastq files) and AlignDx screens each dataset for the presence of pathogens based on a user-selected "pathogen panel" (e.g., human pathogenic viruses). AlignDx then runs Kraken2 and Bracken on each .fastq file and outputs the: estimated abundance of pathogens in the full dataset, and the estimated abundance of pathogens in the full dataset excluding human reads.

The raw data uploaded by users are removed following analysis, but the analysis results are archived for later viewing and associated only with a specific user account to facilitate data privacy. In addition, additional data for each run can be downloaded for offline viewing such as the full set of taxonomic predictions and associated files generated by Kraken2 and Bracken.

(back to top)

Built With

  • FastAPI Celery
  • React.js Next.js
  • Postgres Redis
  • Docker

(back to top)

Getting Started

Usage

For details on usage, and testing of AlignDx using a demo server, please see the usage guidelines.

Prerequisites

  1. Install docker and docker compose.
  2. Install git if you don't have it already.

Installation

  1. Clone the repo

    git clone https://github.com/doxeylab/aligndx.git
  2. Setup the project environmental variables in an .env file, located in the root directory. For details, see this section.

  3. Install the app using the build script. Scripts are provided for both production and local usage respectively.

    ./build.sh 

(back to top)

License

Distributed under the GPLv3 License. See License.txt for more information.

(back to top)

Contact

Manjot Hunjan - [email protected]

Project Link: https://github.com/doxeylab/aligndx

(back to top)

Acknowledgments

Thanks to our many collaborators!

(back to top)

About

AlignDx platform for pathogen detection/surveillance from user-uploaded sequencing data and other data types

Resources

License

Stars

Watchers

Forks

Packages

No packages published