Skip to main content

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

Status:

draft

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 --help
sequana_pipelines_mapper --input-directory DATAPATH

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

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

Uploaded Source

File details

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

File metadata

  • Download URL: sequana_mapper-0.8.4.tar.gz
  • Upload date:
  • Size: 485.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.4.3 requests-toolbelt/0.9.1 tqdm/4.39.0 CPython/3.5.5

File hashes

Hashes for sequana_mapper-0.8.4.tar.gz
Algorithm Hash digest
SHA256 35abead8f210ee9a505dd6b8e91204407d118128e36e8ebfc27b92e2745dd4fd
MD5 6aad3f88674c391f67db85f6ab59fd7b
BLAKE2b-256 25b3bf014842ea773cfcf91bca78f093ebb9b35049931228a00bd178f4404c57

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