Git Product home page Git Product logo

scovtree's Introduction

CFIA-NCFAD/scovtree

SARS-CoV-2 phylogenetic analysis pipeline.

Nextflow

CI

Introduction

CFIA-NCFAD/scovtree is a bioinformatics pipeline for SARS-CoV-2 phylogenetic analysis. Given an input FASTA file with SARS-CoV-2 sequences, this workflow will generate a maximum-likelihood phylogenetic tree (using IQ-TREE from a MAFFT or Nextalign multiple sequence alignment) and interactive HTML tree visualization (shiptv).

This pipeline also allows you to visualize your sequences along with the most closely SARS-CoV-2 sequences from GISAID (if both the GISAID sequences and metadata .tar.xz files are provided). Amino acid mutations can also be determined using Nextclade and shown in the tree visualization.

The pipeline is built using Nextflow, a workflow tool to run tasks across multiple compute infrastructures in a very portable manner. It comes with docker containers making installation trivial and results highly reproducible.

Quick Start

  1. Install nextflow

  2. Install any of Docker, Singularity for full pipeline reproducibility (please only use Conda as a last resort; see docs)

  3. Download the pipeline and test it on a minimal dataset with a single command:

    nextflow run CFIA-NCFAD/scovtree -profile test,<docker/singularity/conda>
  4. Start running your own analysis!

    • Typical command for phylogenetic analysis:

      nextflow run CFIA-NCFAD/scovtree -profile <docker/singularity/conda> \
          --input your-sars-cov-2-sequences.fasta
    • Typical command for phylogenetic analysis with GISAID SARS-CoV-2 data:

      nextflow run CFIA-NCFAD/scovtree -profile <docker/singularity/conda> \
          --input your-sars-cov-2-sequences.fasta \
          --input_metadata your-sars-cov-2-sequences-metadata.tsv \
          --gisaid_sequences sequences_fasta_2021_12_01.tar.xz \
          --gisaid_metadata metadata_tsv_2021_12_01.tar.xz

Credits

CFIA-NCFAD/scovtree was originally written by Hai Nguyen.

Contributors:

  • Peter Kruczkiewicz for workflow conceptualization and software development.
  • jts/ncov-tools for bin/align2alleles.py and bin/phylogenetic_tree_snps.r to create phylogenetic tree with SNPs highlighted using R ggtree

Contributions and Support

If you would like to contribute to this pipeline, please see the contributing guidelines.

For further information or help, don't hesitate to get in touch on the Slack #scovtree channel (you can join with this invite).

Citations

This pipeline tries to follow the best practices for Nextflow workflow development and deployment set by nf-core. You can cite the nf-core publication as follows:

The nf-core framework for community-curated bioinformatics pipelines.

Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso & Sven Nahnsen.

Nat Biotechnol. 2020 Feb 13. doi: 10.1038/s41587-020-0439-x.

In addition, references of tools and data used in this pipeline are as follows:

License

Copyright 2021 Canadian Food Inspection Agency of Canada, Government of Canada.

Distributed under the MIT license.

scovtree's People

Contributors

nhhaidee avatar peterk87 avatar

scovtree's Issues

Add Pango designation aliases support

Sublineages of prevalent Pango lineages are assigned to new alias prefixes. These aliases are tracked in

https://github.com/cov-lineages/pango-designation/blob/master/pango_designation/alias_key.json

For example, lineage B.1.617.2 sublineages are assigned to the AY prefix

https://github.com/cov-lineages/pango-designation/blob/09d3a3bb8744ba9d9b72d30738babd531845b9b2/pango_designation/alias_key.json#L40

There should be a workflow option to take this lineage aliasing into account when filtering for GISAID sequences for phylogenetic analysis to capture more relevant sequences.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.