Skip to main content

Advanced Pipeline for Simple yet Comprehensive AnaLysEs of DNA metabarcoding data - Nanopore application

Project description

apscale

Advanced Pipeline for Simple yet Comprehensive AnaLysEs of DNA metabarcoding data

Downloads - apscale

Downloads - apscale-nanopore

apscale-nanopore

Introduction

Apscale-nanopore is a modified version of the metabarcoding pipeline apscale and is used for the processing of Oxford Nanopore data.

Programs used:

Input:

  • Non-demultiplexed Nanopore sequence data in .fastq format.
  • Demultiplexed Nanopore sequence data in .fastq format.

Output:

  • read table, taxonomy table, log files, report

Installation

Apscale-nanopore can be installed on all common operating systems (Windows, Linux, MacOS). Apscale-nanopore requires Python 3.10 or higher and can be easily installed via pip in any command line:

pip install apscale_nanopore

To update apscale-blast run:

pip install --upgrade apscale_nanopore

The easiest installation option is the Conda apscale environment. This way, all dependencies will automatically be installed.

Then activate the conda environment.

conda activate apscale

Create project

First, create a new project:

apscale_nanopore create -p PATH/TO/PROJECT

A new project will be created. Follow the instructions and fill out the settings file accordingly.

/YOUR_PROJECT_PATH/My_new_project/
├───1_raw_data
│   └───data
├───2_index_demultiplexing
│   └───data
├───3_primer_trimming
│   └───data
├───4_quality_filtering
│   └───data
├───5_clustering_denoising
│   └───data
├───6_read_table
│   └───data
├───7_taxonomic_assignment
│   └───data
├───8_nanopore_report
My_new_project_settings.xlsx

Settings file

Sample index and primer combinations (Example)

Forward index 5'-3' Forward primer 5'-3' Reverse index 5'-3' Reverse primer 5'-3' ID
AGAACGACTTCCATACTCGTGTGA RGCHTTYCCHCGWATAAAYAAYATAAG AGAACGACTTCCATACTCGTGTGA GRGGRTAWACWGTTCAWCCWGTNCC Sample_1
AACGAGTCTCTTGGGACCCATAGA RGCHTTYCCHCGWATAAAYAAYATAAG AACGAGTCTCTTGGGACCCATAGA GRGGRTAWACWGTTCAWCCWGTNCC Sample_2
AGGTCTACCTCGCTAACACCACTG RGCHTTYCCHCGWATAAAYAAYATAAG AGGTCTACCTCGCTAACACCACTG GRGGRTAWACWGTTCAWCCWGTNCC Sample_3
CGTCAACTGACAGTGGTTCGTACT RGCHTTYCCHCGWATAAAYAAYATAAG CGTCAACTGACAGTGGTTCGTACT GRGGRTAWACWGTTCAWCCWGTNCC Sample_4
ACCCTCCAGGAAAGTACCTCTGAT RGCHTTYCCHCGWATAAAYAAYATAAG ACCCTCCAGGAAAGTACCTCTGAT GRGGRTAWACWGTTCAWCCWGTNCC Sample_5
CCAAACCCAACAACCTAGATAGGC RGCHTTYCCHCGWATAAAYAAYATAAG CCAAACCCAACAACCTAGATAGGC GRGGRTAWACWGTTCAWCCWGTNCC Sample_6

Apscale-nanopore settings (Example)

Step Category Variable Comment
General cpu count 7 Number of cores to use
demultiplexing (index) allowed errors index 3 Allowed errors during index demultiplexing
primer trimming allowed errors primer 4 Allowed errors during primer trimming
quality filtering minimum length 54 Reads below this length will be discarded
quality filtering maximum length 74 Reads above this length will be discarded
quality filtering minimum quality 20 Reads below this average PHRED quality score will be discarded
clustering/denoising mode denoised OTUs Choose clustering/denoising algorithm
clustering/denoising percid 0.97 Vsearch clustering percentage identity
clustering/denoising alpha 1 Vsearch denoising alpha value
clustering/denoising d 1 Swarm's d value
read table minimum reads 10 Discard reads below this threshold
taxonomic assignment apscale blast Yes Run APSCALE megablast (yes or no)
taxonomic assignment apscale db ... Path to local database

Run apscale-nanopore

Apscale-nanopore operates in four different ways:

1) Raw-data processing of non-demultiplexed data

  • Copy your non-demultiplexed .fastq(.gz) files to the "1_raw_data/data" folder.

apscale_nanopore run -p PATH/TO/PROJECT

  • Apscale-nanopore will demultiplex all your files according to the demultiplexing sheet.

2) Raw-data processing of demultiplexed data

  • Copy your demultiplexed .fastq(.gz) files to the "1_raw_data/data" folder.

apscale_nanopore run -p PATH/TO/PROJECT -sd

  • Apscale-nanopore will skip the demultiplexing and immediately start with the raw-data processing.
  • Important: Enter the primer sequences (5'-3') in the first row of the demultiplexing sheet. The index columns can be left blank.

3) Live raw-data processing of non-demultiplexed data

  • Output your non-demultiplexed .fastq(.gz) files to the "1_raw_data/data" folder during sequencing.

apscale_nanopore run -p PATH/TO/PROJECT -l

  • Apscale-nanopore will demultiplex all your files according to the demultiplexing sheet.

4) Live raw-data processing of demultiplexed data

  • Output your demultiplexed .fastq(.gz) files to the "1_raw_data/data" folder during sequencing.

apscale_nanopore run -p PATH/TO/PROJECT -l -sd

  • Apscale-nanopore will skip the demultiplexing and immediately start with the raw-data processing.
  • Important: Enter the primer sequences (5'-3') in the first row of the demultiplexing sheet. The index columns can be left blank.

Run individual steps

  • Apscale can run individual steps (-step X) or all steps after a specific module (-steps X).

Step indices:

  • 1 = Index demultiplexing
  • 2 = Primer trimming
  • 3 = Quality filtering
  • 4 = Clustering/denoising
  • 5 = Read table
  • 6 = Taxonomic assignment

Example: Run "clustering/denoising"

apscale_nanopore run -p PATH/TO/PROJECT -step 4

Example: Run all steps after the "quality filtering":

apscale_nanopore run -p PATH/TO/PROJECT -steps 3

Quality control

A quality control can be conducted for all fastq files. Simply run:

apscale_nanopore qc -p PATH/TO/PROJECT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apscale_nanopore-1.0.5.tar.gz (29.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

apscale_nanopore-1.0.5-py3-none-any.whl (31.9 kB view details)

Uploaded Python 3

File details

Details for the file apscale_nanopore-1.0.5.tar.gz.

File metadata

  • Download URL: apscale_nanopore-1.0.5.tar.gz
  • Upload date:
  • Size: 29.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.9

File hashes

Hashes for apscale_nanopore-1.0.5.tar.gz
Algorithm Hash digest
SHA256 cd89b2511d97551240feb9dc16ba95213e59179a27d269018b83b39e25065927
MD5 20c8a1034e65429c2ac7c688466d98c2
BLAKE2b-256 ac66796977aa4a5c61088d018daa8652cd5ab6173229d46ac59486c843ee446f

See more details on using hashes here.

File details

Details for the file apscale_nanopore-1.0.5-py3-none-any.whl.

File metadata

File hashes

Hashes for apscale_nanopore-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 11ba9c6509b90425957e42eaffd8a4caf4bf6acc9303a143256a083665cee69d
MD5 679c127a5995cf2bf64365e0a1bc5391
BLAKE2b-256 45a0a194155da27c2bdf5a349cd9bc02399c18dcaf3a08888ed9eab8331a9d6e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page