This is is the demultiplex pipeline from the Sequana projet
| Overview: | Runs bcl2fastq on raw BCL data and creates plots to ease the QC validation |
|---|---|
| Input: | A valid Illumina base calling directory and sample sheet file |
| Output: | An HTML report, a set of PNG files and the expected FastQ files |
| Status: | production |
| Wiki: | https://github.com/sequana/demultiplex/wiki |
| Documentation: | This README file, the Wiki from the github repository (link above) and https://sequana.readthedocs.io |
| 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 |
Intall the sequana_demultiplex package as follows:
pip install sequana_demultiplex
sequana_demultiplex --help sequana_demultiplex --working-directory DATAPATH --bcl-directory bcldata --sample-sheet SampleSheet.csv --merging-strategy merge
The --bcl-directory option indicates where to find your raw data, the sample-sheet expects the SampleSheet to be compatible with IEM software. The --merging-strategy can be set to none or merge. The merge option merges the lanes, which is useful for e.g. NextSeq sequencers.
This creates a directory fastq. You just need to execute the pipeline:
cd demultiplex sh demultiplex.sh # for a local run
These commands launch a snakemake pipeline. If you are familiar with snakemake, you can retrieve the demultiplex.rules and config.yaml files and then execute the pipeline yourself with specific parameters:
snakemake -s demultiplex.rules --cores 4 --stats stats.txt \
--wrapper-prefix https://raw.githubusercontent.com/sequana/sequana-wrappers/"
You may also use sequanix for a graphical interface.
Would you need to merge the lane, please add the --merging-strategy argument followed by merge:
sequana_demultiplex --bcl-directory bcl_data --merging-strategy merge --sample-sheet SampleSheet.csv
This pipeline requires the following third-party tool(s):
- bcl2fastq 2.20.0
This software has an end-user license agreement (EULA). Given the EULA details of this software, it cannot be distributed according to ` Illumina license <https://support.illumina.com/content/dam/illumina-support/documents/downloads/software/bcl2fastq/bcl2fastq2-v2-20-eula.pdf>`_ Therefore, you should install it yourself. On cluster facility, you may ask to your system administator. For instance:
module load bcl2fastq/2.20.0
For the same reason you cannot find it on community such as bioconda or docker (aug 2020).
So, you will need to download the code yourself. The easiest is to download the RPM from Illumina and accept the agreements. Install it using the RPM if you have a debian-like system:
rpm install file.rpm
If you do not have a debian system, you can look at https://damona.readthedocs.io where we provide a singularity recipes to build an image from your own rpm. Recipes can be found here.
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.
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.
| Version | Description |
|---|---|
| 1.5.2 |
|
| 1.5.1 |
|
| 1.5.0 |
|
| 1.4.0 |
|
| 1.3.1 |
|
| 1.3.0 |
|
| 1.2.1 |
|
| 1.2.0 |
|
| 1.1.3 |
|
| 1.1.2 |
|
| 1.1.1 |
|
| 1.1.0 |
|
| 1.0.5 |
|
| 1.0.4 |
|
| 1.0.3 |
|
| 1.0.2 | Use 'sequana samplesheet --check ' command instead of deprecated sequana_check_sample_sheet command |
| 1.0.1 | change some default behaviour:
|
| 1.0.0 |
|
| 0.9.11 |
|
| 0.9.10 |
|
| 0.9.9 |
|
| 0.9.8 |
|
| 0.9.7 |
|
| 0.9.6 |
|
| 0.9.5 |
|
| 0.9.4 |
|
| 0.9.3 | Fix regression bug |
| 0.9.2 | remove warning due to relative paths. |
| 0.9.1 | Make the merging options compulsory. Users must tell whether they want to merge the lanes or not. This avoid to do the merging or not whereas the inverse was expected. |
| 0.8.6 | Uses 64G/biomics queue and 16 cores on a SLURM scheduler |
To contribute to this project, please take a look at the Contributing Guidelines first. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.