Coder Social home page Coder Social logo

nokcs / wf-artic Goto Github PK

View Code? Open in Web Editor NEW

This project forked from epi2me-labs/wf-artic

0.0 0.0 0.0 25.08 MB

ARTIC SARS-CoV-2 workflow and reporting

Home Page: https://labs.epi2me.io/

License: Mozilla Public License 2.0

Shell 2.24% Python 37.26% Groovy 30.94% Dockerfile 0.70% Nextflow 28.86%

wf-artic's Introduction

ARTIC SARS-CoV-2 Workflow

This repository contains a nextflow workflow for running the ARTIC SARS-CoV-2 workflow on multiplexed MinION, GridION, and PromethION runs.

Introduction

The wf-artic workflow implements a slightly modified ARTIC FieldBioinformatics workflow for the purpose of preparing consensus sequences from SARS-CoV-2 genomes that have been DNA sequenced using a pooled tiling amplicon strategy.

The workflow consumes a folder containing demultiplexed sequence reads as prepared by either MinKNOW or Guppy. The workflow needs to know the primer scheme that has been used during genome amplication and library preparation e.g. ARTIC/V3 or ONT_Midnight/V1. Other parameters can be specified to e.g. assign sample names to the barcodes or to adjust the length distribution of acceptable amplicon sequences.

DNA sequences in FASTQ format are aggregated, filtered for sequence length and quality characteristics and are mapped to the reference SARS-CoV-2 genome using minimap2. A primer-scheme specific bed file is used to identify the regions of the mapped sequences that correspond to synthetic sequences (primers) - these regions are clipped to ensure that sequences are entirely of biological origin. The retained sequences are used to prepare a consensus sequence that is then polished using Medaka and variant calling is performed to produce a VCF file of genetic differences relative to the reference genome. The consensus sequence is annotated for virus clade information using NextClade and a strain assignment is performed using Pangolin.

The completed analysis is summarised in an HTML format report that summarises key information that includes number of reads, depth of coverage information per amplicon and both the Nextclade and Pangolin information.

Quickstart

The workflow uses nextflow to manage compute and software resources, as such nextflow will need to be installed before attempting to run the workflow.

The workflow can currently be run using either Docker or conda to provide isolation of the required software. Both methods are automated out-of-the-box provided either docker of conda is installed.

It is not required to clone or download the git repository in order to run the workflow. For more information on running EPI2ME Labs workflows visit out website.

Workflow options

To obtain the workflow, having installed nextflow, users can run:

nextflow run epi2me-labs/wf-artic --help

to see the options for the workflow.

Workflow outputs

The primary outputs of the workflow include:

  • a FASTA file containing the consensus sequence for all samples,
  • a VCF file sample all samples,
  • an HTML report document detailing QC metrics and the primary findings of the workflow.

Useful links

wf-artic's People

Contributors

akspurr avatar cjw85 avatar mattdmem avatar nrhorner avatar sarahjeeeze avatar

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.