Skip to content

chaoatic/amplimap-nf

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

amplimap-nf

AmpliMap is a bioinformatic pipeline for aligning amplicon reads to a DNA database. This pipeline is based on Nextflow.

Getting started

Prerequisites

Installation

git clone https://github.com/chaoatic/amplimap-nf.git
cd amplimap-nf

Usage

Usage: nextflow run amplimap.nf [OPTION...]

Mandatory arguments:
    --data_dir      Path to sequences directory with sequences in fastq.gz format
    --db            Path to database file with sequences in fasta format
    --result_dir    Path to directory containing results

Optional arguments:
    --min_length    Minimum length (bp) for a read to be retained
                    [Default: 1]
    --max_length    Maximum length (bp) for a read to be retained
                    [Default: 2147483647]
    --min_qscore    Minimum average PHRED score for a read to be retained
                    [Default: 1]
    --threads       Number of parallel threads to use
                    [Default: 4]

Example usage

nextflow run amplimap.nf \
    --data_dir "/DATA/DIRECTORY" \
    --db DB.fasta \
    --result_dir "/RESULT/DIRECTORY" \
    --min_length 500 \
    --max_length 1000 \
    --min_qscore 10 \
    --threads 4

Overview

amplimap pipeline flowchart

This pipeline is composed of a set of processes to compare amplicon reads against a reference database, then produce a coverage report for each sample.

  • concatenateFastq: import all fastq files and concatenate them together into each barcode.
  • rawSequenceVisualization: produce graphs and data visualizations of raw read sequences for each barcode.
  • filterFastq: filter reads according to parameters provided.
  • filterSequenceVisualization: produce graphs and data visualizations of filtered read sequences.
  • generateSequenceReport: generate statistic report of each barcode sequence.
  • generateCoverageReport generate coverage report of each barcode sequence.

Citation

If you use AmpliMap please cite:

About

A bioinformatic pipeline for aligning amplicon reads to a DNA database based on Nextflow

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published