Skip to content

ktmeaton/plague-phylogeography

Repository files navigation

ktmeaton/plague-phylogeography

An open-source pipeline to construct a global phylogeny of the plague pathogen Yersinia pestis.

License: MIT Build Status Pipeline CI GitHub issues Docker Image Open in Gitpod

Pipeline Overview

  1. Create a metadata database of NCBI genomic assemblies and SRA data.
  2. Download assemblies and SRA fastq files.
  3. Align assemblies and fastq files to a reference genome.
  4. Mask problematic regions.
  5. Evaluate statistics.
  6. Estimate a maximum-likelihood phylogeny.
  7. Estimate a time-scaled phylogeny.
  8. Web-based visualization.

Showcase

Install

All install options start by cloning the pipeline repo.

git clone https://github.com/ktmeaton/plague-phylogeography.git
cd plague-phylogeography

1. Conda

  • Create a conda environment with dependencies.
  • Mamba is not strictly necessary but it is heavily recommended.
conda install -c conda-forge mamba
mamba env create -f workflow/envs/merge/environment.yaml
  • Install LSD2 (not available through conda).
# Download binary
wget https://github.com/tothuhien/lsd2/releases/download/v1.9.9/lsd2_unix
# Move into the conda binary path and rename
mv lsd2_unix ~/miniconda3/envs/plague-phylogeography/bin/lsd2
  • Test the help command.
snakemake --profile profiles/laptop help

(While mamba is not strictly necessary, it is heavily recommended.)

snakemake --profile profiles/laptop all

2. Docker

docker pull ktmeaton/plague-phylogeography:dev
docker run \
  -v $PWD:/pipeline \
  -w /pipeline \
  ktmeaton/plague-phylogeography:dev \
  snakemake --profile profiles/laptop help

Demo

1. Conda

snakemake --profile profiles/laptop all

2. Docker

docker run \
  -v $PWD:/pipeline \
  -w /pipeline \
  ktmeaton/plague-phylogeography:dev \
  snakemake --profile profiles/laptop all

Credits

Author: Katherine Eaton
Logo: Emil Karpinski, Katherine Eaton