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.

Output:

A set of BAM files (and/or bigwig)

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.

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.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.

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (1.5.0)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for cokelaer from gravatar.com cokelaer

Credits

Author/Maintainer: thomas cokelaer

License

BSD License (new BSD)

Tags

snakemake sequana bwa bowtie2 minimap2

Classifiers

Report project as malware

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.8.13.tar.gz (627.6 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: sequana_mapper-0.8.13.tar.gz
  • Upload date:
  • Size: 627.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3.post20200325 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.3

File hashes

Hashes for sequana_mapper-0.8.13.tar.gz
Algorithm Hash digest
SHA256 6e9933d19ea983882e8ca58c4aa82df9937acd824d15b256456f69efd2f18ac2
MD5 9881aa6c24cddd1cff5e950345f96db7
BLAKE2b-256 b0530969c133b40f5ad380b4e33fb21b33c7a346d75d92d9b03fc8deb497c97c

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