garfinjm / augur-nf

Nextflow implementation of Nextstrain's Augur pipeline

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

augur-nf

This repository contains a Nextflow implementation of Nexstrain's Augur pipeline (https://github.com/nextstrain/augur). From Augur's github page:

"Augur is the bioinformatics toolkit to track evolution from sequence and serological data. It provides a collection of commands which are designed to be composable into larger processing pipelines."

Using the pipeline

The pipeline is designed to start from assembled genomes in fasta format. All assemblies must be in the same fasta file. Additionally, a reference genome in Genbank format, a tsv of metadata, a tsv containing country of origin and hex color codes, a tsv containing latitude and longitude coordinates for country of origin and an Auspice config file are required. Please see this tutorial for more information on the file format requirements for each input.

Start the pipeline using nextflow augur.nf and follow the options for running the pipeline.

usage: nextflow augur.nf [--output] [--filter] [--min_date] [--traits]
             --sequences <path> --refernce <path> --metadata <path> --colors <path> 
             --lat_long <path> --config <path>

required arguments:
  sequences                Path to fasta file of assemblies
  reference                Path to reference genome in Genbank format
  metadata                 Path to metadata file
  colors                   Path to tsv file containing hex color codes and country of origin
  lat_long                 Path to tsv file containing lonfitude and latitude coordinates of countries of origin
  config                   Path to Auspice config file
  
optional arguments:
  --output  <output_path>  Path to ouput directory, default "augur_results".
  --filter  <path>         Filter out a list of sequences
  --min_date               Minimum date for sequences to include (use with --filter)
  --seq_per_group          Number of sequences per group (use with --filter)
  --traits                 Perform ancestral reconstruction using country of origin as a trait    

About

Nextflow implementation of Nextstrain's Augur pipeline


Languages

Language:Nextflow 100.0%