.. image:: https://badge.fury.io/py/sequana-mapper.svg
:target: https://pypi.python.org/pypi/sequana_mapper
.. image:: https://github.com/sequana/mapper/actions/workflows/main.yml/badge.svg
:target: https://github.com/sequana/mapper/actions/
.. image:: https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C3.11-blue.svg
:target: https://pypi.python.org/pypi/sequana
:alt: Python 3.9 | 3.10 | 3.11
.. image:: http://joss.theoj.org/papers/10.21105/joss.00352/status.svg
:target: http://joss.theoj.org/papers/10.21105/joss.00352
:alt: JOSS (journal of open source software) DOI
This is the **mapper** pipeline from the `Sequana <https://sequana.readthedocs.org>`_ 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
:Documentation: This README file, 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
Installation
~~~~~~~~~~~~
If you already have all requirements, you can install the packages using pip::
pip install sequana_mapper --upgrade
You will need third-party software such as fastqc. Please see below for details.
Usage
~~~~~
This command will scan all files ending in .fastq.gz found in the local
directory, create a directory called mapper/ where a snakemake pipeline can be executed.::
sequana_mapper --input-directory DATAPATH --mapper bwa --create-bigwig
sequana_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 \
--wrapper-prefix https://raw.githubusercontent.com/sequana/sequana-wrappers/
Or use `sequanix <https://sequana.readthedocs.io/en/main/sequanix.html>`_ interface.
Requirements
~~~~~~~~~~~~
This pipelines requires the following executable(s):
- bamtools
- bwa
- multiqc
- sequana_coverage
- minimap2
- bowtie2
- deeptools
.. image:: https://raw.githubusercontent.com/sequana/mapper/main/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 is automatically added to the config.yaml file and the
readtag is set to None.
The BAM files are filtered to remove unmapped reads to keep BAM files to minimal size. However,
the multiqc and statistics to be found in {sample}/bamtools_stats/ includes mapped and unmapped reads information. Each BAM file is stored in a directory named after the sample.
Rules and configuration details
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Here is the `latest documented configuration file <https://raw.githubusercontent.com/sequana/mapper/main/sequana_pipelines/mapper/config.yaml>`_
to be used with the pipeline. Each rule used in the pipeline may have a section in the configuration file.
Changelog
~~~~~~~~~
========= ======================================================================
Version Description
========= ======================================================================
1.2.1 * fix bwa_split bwa aggreate stage (bug fix)
1.2.0 * Implement a bwa_split method to speed up mapping of very large
fastq files.
1.1.0 * BAM files are now filtered to remove unmapped reads
* set wrappers branch in config file and update pipeline.
* refactorise to use click and new sequana-pipetools
1.0.0 * Use latest sequana-wrappers and graphviz apptainer
0.12.0 * Use latest pipetools and add singularity containers
0.11.1 * Fix typo when setting coverage to True and allow untagged filenames
0.11.0 * implement feature counts for capture-seq projects
0.10.1 * remove getlogdir and getname
0.10.0 * use new wrappers framework
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.**
========= ======================================================================
Contribute & Code of Conduct
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To contribute to this project, please take a look at the
`Contributing Guidelines <https://github.com/sequana/sequana/blob/main/CONTRIBUTING.rst>`_ first. Please note that this project is released with a
`Code of Conduct <https://github.com/sequana/sequana/blob/main/CONDUCT.md>`_. By contributing to this project, you agree to abide by its terms.
Raw data
{
"_id": null,
"home_page": "https://github.com/sequana/mapper",
"name": "sequana-mapper",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "snakemake, NGS, sequana, bwa, minimap2",
"author": "Sequana Team",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/a1/32/367bd0d76b39b978388622567755758c9a71de2d7715c615a3711ba277d9/sequana_mapper-1.3.0.tar.gz",
"platform": null,
"description": "\n.. image:: https://badge.fury.io/py/sequana-mapper.svg\n :target: https://pypi.python.org/pypi/sequana_mapper\n\n.. image:: https://github.com/sequana/mapper/actions/workflows/main.yml/badge.svg\n :target: https://github.com/sequana/mapper/actions/\n\n.. image:: https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C3.11-blue.svg\n :target: https://pypi.python.org/pypi/sequana\n :alt: Python 3.9 | 3.10 | 3.11\n\n.. image:: http://joss.theoj.org/papers/10.21105/joss.00352/status.svg\n :target: http://joss.theoj.org/papers/10.21105/joss.00352\n :alt: JOSS (journal of open source software) DOI\n\nThis is the **mapper** pipeline from the `Sequana <https://sequana.readthedocs.org>`_ projet\n\n:Overview: This is a simple pipeline to map several FastQ files onto a reference using different mappers/aligners\n:Input: A set of FastQ files (illumina, pacbio, etc).\n:Output: A set of BAM files (and/or bigwig) and HTML report\n:Status: Production\n:Documentation: This README file, and https://sequana.readthedocs.io\n: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\n\nInstallation\n~~~~~~~~~~~~\n\nIf you already have all requirements, you can install the packages using pip::\n\n pip install sequana_mapper --upgrade\n\nYou will need third-party software such as fastqc. Please see below for details.\n\nUsage\n~~~~~\n\nThis command will scan all files ending in .fastq.gz found in the local\ndirectory, create a directory called mapper/ where a snakemake pipeline can be executed.::\n\n sequana_mapper --input-directory DATAPATH --mapper bwa --create-bigwig\n sequana_mapper --input-directory DATAPATH --mapper bwa --do-coverage\n\nThis creates a directory with the pipeline and configuration file. You will then need\nto execute the pipeline::\n\n cd mapper\n sh mapper.sh # for a local run\n\nThis launch a snakemake pipeline. If you are familiar with snakemake, you can\nretrieve the pipeline itself and its configuration files and then execute the pipeline yourself with specific parameters::\n\n snakemake -s mapper.rules -c config.yaml --cores 4 \\\n --wrapper-prefix https://raw.githubusercontent.com/sequana/sequana-wrappers/\n\nOr use `sequanix <https://sequana.readthedocs.io/en/main/sequanix.html>`_ interface.\n\n\nRequirements\n~~~~~~~~~~~~\n\nThis pipelines requires the following executable(s):\n\n- bamtools\n- bwa\n- multiqc\n- sequana_coverage\n- minimap2\n- bowtie2\n- deeptools\n\n.. image:: https://raw.githubusercontent.com/sequana/mapper/main/sequana_pipelines/mapper/dag.png\n\n\nDetails\n~~~~~~~~~\n\nThis pipeline runs **mapper** in parallel on the input fastq files (paired or not).\nA brief sequana summary report is also produced. When using **--pacbio** option,\n*-x map-pb* options is automatically added to the config.yaml file and the\nreadtag is set to None.\n\nThe BAM files are filtered to remove unmapped reads to keep BAM files to minimal size. However,\nthe multiqc and statistics to be found in {sample}/bamtools_stats/ includes mapped and unmapped reads information. Each BAM file is stored in a directory named after the sample.\n\n\n\nRules and configuration details\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nHere is the `latest documented configuration file <https://raw.githubusercontent.com/sequana/mapper/main/sequana_pipelines/mapper/config.yaml>`_\nto be used with the pipeline. Each rule used in the pipeline may have a section in the configuration file.\n\n\nChangelog\n~~~~~~~~~\n\n========= ======================================================================\nVersion Description\n========= ======================================================================\n1.2.1 * fix bwa_split bwa aggreate stage (bug fix)\n1.2.0 * Implement a bwa_split method to speed up mapping of very large\n fastq files.\n1.1.0 * BAM files are now filtered to remove unmapped reads\n * set wrappers branch in config file and update pipeline.\n * refactorise to use click and new sequana-pipetools\n1.0.0 * Use latest sequana-wrappers and graphviz apptainer\n0.12.0 * Use latest pipetools and add singularity containers\n0.11.1 * Fix typo when setting coverage to True and allow untagged filenames\n0.11.0 * implement feature counts for capture-seq projects\n0.10.1 * remove getlogdir and getname\n0.10.0 * use new wrappers framework\n0.9.0 * fix issue with logger and increments requirements\n * add new option --pacbio to automatically set the options for\n pacbio data (-x map-pb and readtag set to None)\n0.8.13 * add the thread option in minimap2 case\n0.8.12 * factorise multiqc rule\n0.8.11 * Implemente the --from-project option and new framework\n * custom HTMrLl report\n0.8.10 * change samtools_depth rule and switched to bam2cov to cope with null\n coverage\n0.8.9 * fix requirements\n0.8.8 * fix pipeline rule for bigwig + renamed output_bigwig into\n create_bigwig; fix the multiqc config file\n0.8.7 * fix config file creation (for bigwig)\n0.8.6 * added bowtie2 mapper + bigwig as output, make coverage optional\n0.8.5 * create a sym link to the HTML report. Better post cleaning.\n0.8.4 * Fixing multiqc (synchronized with sequana updates)\n0.8.3 * add sequana_coverage rule.\n0.8.2 * add minimap2 mapper\n0.8.1 * fix bamtools stats rule to have different output name for multiqc\n0.8.0 **First release.**\n========= ======================================================================\n\n\nContribute & Code of Conduct\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nTo contribute to this project, please take a look at the\n`Contributing Guidelines <https://github.com/sequana/sequana/blob/main/CONTRIBUTING.rst>`_ first. Please note that this project is released with a\n`Code of Conduct <https://github.com/sequana/sequana/blob/main/CONDUCT.md>`_. By contributing to this project, you agree to abide by its terms.\n",
"bugtrack_url": null,
"license": "BSD-3",
"summary": "A multi-sample mapper to map reads onto a reference",
"version": "1.3.0",
"project_urls": {
"Homepage": "https://github.com/sequana/mapper",
"Repository": "https://github.com/sequana/mapper"
},
"split_keywords": [
"snakemake",
" ngs",
" sequana",
" bwa",
" minimap2"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a667e4806704578d2a7d073122a6687d40bd73350823588b8032ef6f97e90d9b",
"md5": "d2e9ba1fc490a9197949d156b0ad1e38",
"sha256": "e410420dec1e00ae6dc463172ed50e7f64036d9b0daca30255a2efcfc3ecf4b7"
},
"downloads": -1,
"filename": "sequana_mapper-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d2e9ba1fc490a9197949d156b0ad1e38",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 71317,
"upload_time": "2024-10-19T19:01:59",
"upload_time_iso_8601": "2024-10-19T19:01:59.023512Z",
"url": "https://files.pythonhosted.org/packages/a6/67/e4806704578d2a7d073122a6687d40bd73350823588b8032ef6f97e90d9b/sequana_mapper-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a132367bd0d76b39b978388622567755758c9a71de2d7715c615a3711ba277d9",
"md5": "3ef0999566075a57ccdafa3af2dbe319",
"sha256": "94836d937439e0f8e5fcd88ce38963e7fddb97210e35f527cafc861ace889d2d"
},
"downloads": -1,
"filename": "sequana_mapper-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "3ef0999566075a57ccdafa3af2dbe319",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 72482,
"upload_time": "2024-10-19T19:02:00",
"upload_time_iso_8601": "2024-10-19T19:02:00.992468Z",
"url": "https://files.pythonhosted.org/packages/a1/32/367bd0d76b39b978388622567755758c9a71de2d7715c615a3711ba277d9/sequana_mapper-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-19 19:02:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sequana",
"github_project": "mapper",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sequana-mapper"
}
JSON
