sequana-mapper

This is is the mapper pipeline from the Sequana projet

Overview:: This is a simple pipeline to map several FastQ files onto a reference using different mappers/aligners
Input:: A set of FastQ files (illumina, pacbio, etc).
Output:: A set of BAM files (and/or bigwig) and HTML report
Status:: Production
Citation:: Cokelaer et al, (2017), ‘Sequana’: a Set of Snakemake NGS pipelines, Journal of Open Source Software, 2(16), 352, JOSS DOI doi:10.21105/joss.00352

Installation

You must install Sequana first:

pip install sequana

Then, just install this package:

pip install sequana_mapper

Usage

sequana_pipelines_mapper --input-directory DATAPATH  --mapper bwa --create-bigwig
sequana_pipelines_mapper --input-directory DATAPATH  --mapper bwa --do-coverage

This creates a directory with the pipeline and configuration file. You will then need to execute the pipeline:

cd mapper
sh mapper.sh  # for a local run

This launch a snakemake pipeline. If you are familiar with snakemake, you can retrieve the pipeline itself and its configuration files and then execute the pipeline yourself with specific parameters:

snakemake -s mapper.rules -c config.yaml --cores 4 --stats stats.txt

Or use sequanix interface.

Requirements

This pipelines requires the following executable(s):

bamtools
bwa
multiqc
sequana_coverage
minimap2
bowtie2
deeptools

https://raw.githubusercontent.com/sequana/sequana_mapper/master/sequana_pipelines/mapper/dag.png

Details

This pipeline runs mapper in parallel on the input fastq files (paired or not). A brief sequana summary report is also produced. When using –pacbio option, -x map-pb options ia automatically added to the config.yaml file and the readtag is set to None.

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.

Changelog

Version	Description
0.9.0	fix issue with logger and increments requirements add new option –pacbio to automatically set the options for pacbio data (-x map-pb and readtag set to None)
0.8.13	add the thread option in minimap2 case
0.8.12	factorise multiqc rule
0.8.11	Implemente the –from-project option and new framework custom HTMrLl report
0.8.10	change samtools_depth rule and switched to bam2cov to cope with null coverage
0.8.9	fix requirements
0.8.8	fix pipeline rule for bigwig + renamed output_bigwig into create_bigwig; fix the multiqc config file
0.8.7	fix config file creation (for bigwig)
0.8.6	added bowtie2 mapper + bigwig as output, make coverage optional
0.8.5	create a sym link to the HTML report. Better post cleaning.
0.8.4	Fixing multiqc (synchronized with sequana updates)
0.8.3	add sequana_coverage rule.
0.8.2	add minimap2 mapper
0.8.1	fix bamtools stats rule to have different output name for multiqc
0.8.0	First release.

Download files

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

Source Distribution

sequana_mapper-0.9.0.tar.gz (520.8 kB view details)

Uploaded Apr 16, 2021 Source

File details

Details for the file sequana_mapper-0.9.0.tar.gz.

File metadata

Download URL: sequana_mapper-0.9.0.tar.gz
Upload date: Apr 16, 2021
Size: 520.8 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.4.1 importlib_metadata/3.10.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.7.3

File hashes

Hashes for sequana_mapper-0.9.0.tar.gz
Algorithm	Hash digest
SHA256	`28a601657a07c080f27e421deffdd75bc6a1a992aa6ecdbc85d2ba6e48642419`
MD5	`ba35b355156f91cdc426995b2448d40a`
BLAKE2b-256	`9951afb06a758b41abce685d65f86c2c10a67e1a59d03eb2ab04b67db6e77bf4`