Sign inSign up

remiolsen/anglerfish

By remiolsen

•Updated almost 2 years ago

Image
0

628

remiolsen/anglerfish repository overview

⁠Anglerfish

Anglerfish CI Status Docker Container available

⁠Introduction

Anglerfish is a tool designed to demultiplex Illumina libraries sequenced on Oxford Nanopore flowcells. The primary purpose for this would be to do QC, i.e. to check pool balancing, assess contamination, library insert sizes and so on.

For more information on how this can be used, please see this poster⁠.

⁠Installation

⁠Requirements
  • Python3 (3.6)

Python modules:

  • biopython v. 1.70
  • python-levenshtein v. 0.12.0
  • numpy v. 1.19.2

Software:

  • minimap2 v. 2.17
  • fastqc v. 0.11.9 (optional)
  • multiqc v. 1.8 (optional)
⁠Manually using pip
pip install --upgrade --force-reinstall git+https://github.com/remiolsen/anglerfish.git
⁠Manually with Conda

First install miniconda⁠, then:

git clone https://github.com/remiolsen/anglerfish.git
cd anglerfish
# Create a the anglerfish conda environment
conda env create -f environment.yml
# Install anglerfish
pip install -e .
⁠Docker
docker pull remiolsen/anglerfish:<version>

⁠Usage

Anglerfish requires two files to run.

  • A basecalled FASTQ file from for instance Guppy (/path/to/ONTreads.fastq.gz)
  • A samplesheet containing the sample names and indices expected to be found in the sequencing run. (/path/to/samples.csv)

Example of a samplesheet file:

P12864_201,truseq_dual,TAATGCGC-CAGGACGT,/path/to/ONTreads.fastq.gz
P12864_202,truseq_dual,TAATGCGC-GTACTGAC,/path/to/ONTreads.fastq.gz
P9712_101, truseq_dual,ATTACTCG-TATAGCCT,/path/to/ONTreads.fastq.gz
P9712_102, truseq_dual,ATTACTCG-ATAGAGGC,/path/to/ONTreads.fastq.gz
P9712_103, truseq_dual,ATTACTCG-CCTATCCT,/path/to/ONTreads.fastq.gz
P9712_104, truseq_dual,ATTACTCG-GGCTCTGA,/path/to/ONTreads.fastq.gz
P9712_105, truseq_dual,ATTACTCG-AGGCGAAG,/path/to/ONTreads.fastq.gz
P9712_106, truseq_dual,ATTACTCG-TAATCTTA,/path/to/ONTreads.fastq.gz

Or using single index:

P12345_101,truseq,CAGGACGT,/path/to/ONTreads.fastq.gz

Then run:

anglerfish.py -o /path/to/samples.csv
⁠Optional
--out_fastq OUT_FASTQ, -o OUT_FASTQ
                      Analysis output folder (default: Current dir)
--samplesheet SAMPLESHEET, -s SAMPLESHEET
                      CSV formatted list of samples and barcodes
--threads THREADS, -t THREADS
                      Number of threads to use (default: 4)
--skip_demux, -c      Only do BC counting and not demuxing
--skip_fastqc, -f     After demuxing, skip running FastQC+MultiQC
--max-distance MAX_DISTANCE, -m MAX_DISTANCE
                      Manually adjust maximum edit distance for BC matching
⁠Output files

In folder anglerfish_????_??_??_?????/

  • *.fastq.gz Demultuplexed reads (if any)
  • anglerfish_stats.txt Barcode statistics from anglerfish run
  • fastqc/ raw output from fastqc (if run)
  • multiqc/anglerfish_results_multiqc_report.html Summary of demultiplexed reads

⁠Credits

The Anglerfish code was written by @remiolsen⁠ but it would not exist without the contributions of @FranBonath⁠, @taborsak⁠, @ssjunnebo⁠ and Carl Rubin. Also, the Anglerfish logo⁠ was designed by @FranBonath⁠.

Tag summary

Content type

Image

Digest

sha256:7d238cfff…

Size

563 MB

Last updated

almost 2 years ago

docker pull remiolsen/anglerfish:test