Skip to main content

Pipeline that runs bcl2fastq and creates additional plots within a Snakemake workflow

Project description

This is is the demultiplex pipeline from the Sequana projet

Overview:Runs bcl2fastq on raw BCL data and create some QC plots to ease the QC step
Input:A valid Illumina base calling directory
Output:a set of PNG files and the expected FastQ files
Status:production
Citation:Cokelaer et al, (2017), ‘Sequana’: a Set of Snakemake NGS pipelines, Journal of Open Source Software, 2(16), 352, JOSS DOI https://doi:10.21105/joss.00352

Installation

You must install Sequana first:

pip install sequana

Then, just install this package:

pip install sequana_demultiplex

Usage

sequana_pipelines_demultiplex --help
sequana_pipelines_demultiplex --working-directory DATAPATH --bcl-directory bcldata

This creates a directory fastq. You just need to execute the pipeline:

cd demutliplex
sh demutliplex.sh  # for a local run

This launch a snakemake pipeline. If you are familiar with snakemake, you can retrieve the demutliplex.rules and config.yaml files and then execute the pipeline yourself with specific parameters:

snakemake -s demutliplex.rules --cores 4 --stats stats.txt

Or use sequanix interface.

Requirements

This pipelines requires the following executable(s):

  • bcl2fastq 2.20.0
https://raw.githubusercontent.com/sequana/sequana_demulitiplex/master/sequana_pipelines/demultiplex/dag.png

Details

This pipeline runs bcl2fastq 2.20 and creates a set of diagnostics plots to help deciphering common issues such as missing index and sample sheet errors.

Rules and configuration details

Here is the latest documented configuration file to be used with the pipeline. Each rule used in the pipeline may have a section in the configuration file.

Project details


Download files

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

Files for sequana-demultiplex, version 0.8.6
Filename, size File type Python version Upload date Hashes
Filename, size sequana_demultiplex-0.8.6.tar.gz (13.0 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page