This is is the **coverage** pipeline from the `Sequana <https://sequana.readthedocs.org>`_ project
.. image:: https://badge.fury.io/py/sequana-multicov.svg
:target: https://pypi.python.org/pypi/sequana_multicov
.. 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
.. image:: https://github.com/sequana/multicov/actions/workflows/main.yml/badge.svg
:target: https://github.com/sequana/multicov/actions/workflows
:Overview: Parallelised version of sequana_coverage for large eukaryotes genome.
:Input: A set of BAM or BED files. BED file must have 3 or 4 columns. First column is
the chromosome/contig name, second column stored positions and third the
coverage. Fourth optional columns contains a filtered coverage (not used in
the analysis but shown in the HTML reports)
:Output: a set of HTML reports for each chromosomes and a multiqc report
:Status: production
:Citation:
Dimitri Desvillechabrol, Christiane Bouchier, Sean Kennedy, Thomas Cokelaer
*Sequana coverage: detection and characterization of genomic variations
using running median and mixture models*
GigaScience, Volume 7, Issue 12, December 2018, giy110,
https://doi.org/10.1093/gigascience/giy110
and
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
~~~~~~~~~~~~
sequana_multicov is based on Python3, just install the package as follows::
pip install sequana_multicov --upgrade
Usage
~~~~~
::
sequana_multicov --help
sequana_multicov --input-directory DATAPATH
By default, this looks for BED file. WARNING. This are BED3 meaning a 3-columns
tabulated file like this one::
chr1 1 10
chr1 2 11
...
chr1 N1 10
chr2 1 20
chr2 2 21
...
chr2 N2 20
where the first column stored the chromosome name, the second is the position
and the third is the coverage itself. See sequana_coverage documentation for
details. If you have BAM files as input, we will do the conversion for you. In
such case, use this option::
--input-pattern "*.bam"
The sequana_coverage script creates a directory with the pipeline and
its configuration file. You will then need
to execute the pipeline::
cd coverage
sh coverage.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 multicov.rules -c config.yaml --cores 4 --stats stats.txt
Or use `sequanix <https://sequana.readthedocs.io/en/master/sequanix.html>`_ interface as follows::
sequanix -w analysis -i . -p coverage
Go to the second panel, in Input data and then in Input directory. There, you
must modify the pattern (empty field by default meaning search for fastq files)
and set the field to either::
*.bed
or::
*.bam
You are ready to go. Save the project and press Run. Once done, open the HTML report.
Requirements
~~~~~~~~~~~~
This pipelines requires the following executable(s):
- sequana_coverage from **Sequana**, which should be installed automatically.
- multiqc
.. .. image:: https://raw.githubusercontent.com/sequana/multicov/master/sequana_pipelines/multicov/dag.png
Details
~~~~~~~~~
This pipeline runs **coverage** in parallel on the input BAM files (or BED file).
The coverage tool takes as input a BAM or a BED file. The BED file must have 3
or 4 columns as explained in the standalone application (sequana_coverage)
`documentation <http://sequana.readthedocs.io/en/master/applications.html?highlight=coverage#sequana-coverage>`_.
In short, the first column is the chromosome name, the second column is the
position (sorted) and the third column is the coverage (an optional fourth
column would contain a coverage signal, which could be high quality coverage for
instance).
If you have only BAM files, you can convert them using **bioconvert** tool or
the command::
samtools depth -aa input.bam > output.bed
If you have a CRAM file::
samtools view -@ 4 -T reference.fa -b -o out.bam in.cram
For very large BAM/BED files, we recommend to split the BED file by
chromosomes. For instance for the chromosome chr1, type::
# samtools index in.bam
samtools depth -aa input.bam -r chr1 in.bam > chr1.bed
The standalone or Snakemake application can also take as input your BAM file and
will convert it automatically into a BED file.
Rules and configuration details
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Here is the `latest documented configuration file <https://raw.githubusercontent.com/sequana/multicov/main/sequana_pipelines/multicov/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.1.0 * set apptainer containers and use wrappers
1.0.0 * renamed into multicov.
* update to use latest sequana_pipetools (v0.9.2)
0.9.1 * rename genbank field into annotation, window into window_size
0.9.0 * first version
========= ====================================================================
Raw data
{
"_id": null,
"home_page": "https://github.com/sequana/",
"name": "sequana-multicov",
"maintainer": "thomas cokelaer",
"docs_url": null,
"requires_python": "",
"maintainer_email": "thomas.cokelaer@pasteur.fr",
"keywords": "coverage, snakemake, sequana, running median, CNV, depltion",
"author": "thomas cokelaer",
"author_email": "thomas.cokelaer@pasteur.fr",
"download_url": "https://files.pythonhosted.org/packages/ec/cf/f56b129a3b394996bda36eaaede4929624400fe93bc1533e57dd6302790a/sequana_multicov-1.1.1.tar.gz",
"platform": "Linux",
"description": "This is is the **coverage** pipeline from the `Sequana <https://sequana.readthedocs.org>`_ project\n\n\n.. image:: https://badge.fury.io/py/sequana-multicov.svg\n :target: https://pypi.python.org/pypi/sequana_multicov\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\n.. image:: https://github.com/sequana/multicov/actions/workflows/main.yml/badge.svg\n :target: https://github.com/sequana/multicov/actions/workflows \n\n\n:Overview: Parallelised version of sequana_coverage for large eukaryotes genome.\n:Input: A set of BAM or BED files. BED file must have 3 or 4 columns. First column is\n the chromosome/contig name, second column stored positions and third the\n coverage. Fourth optional columns contains a filtered coverage (not used in\n the analysis but shown in the HTML reports)\n:Output: a set of HTML reports for each chromosomes and a multiqc report\n:Status: production\n:Citation: \n Dimitri Desvillechabrol, Christiane Bouchier, Sean Kennedy, Thomas Cokelaer\n *Sequana coverage: detection and characterization of genomic variations \n using running median and mixture models*\n GigaScience, Volume 7, Issue 12, December 2018, giy110, \n https://doi.org/10.1093/gigascience/giy110\n\n and \n\n Cokelaer et al, (2017), \u2018Sequana\u2019: a Set of Snakemake NGS pipelines, Journal of Open Source Software, 2(16), 352, JOSS DOI https://doi:10.21105/joss.00352\n\n\nInstallation\n~~~~~~~~~~~~\n\n\nsequana_multicov is based on Python3, just install the package as follows::\n\n pip install sequana_multicov --upgrade\n\n\nUsage\n~~~~~\n\n::\n\n sequana_multicov --help\n sequana_multicov --input-directory DATAPATH \n\nBy default, this looks for BED file. WARNING. This are BED3 meaning a 3-columns\ntabulated file like this one::\n\n chr1 1 10\n chr1 2 11\n ...\n chr1 N1 10\n chr2 1 20\n chr2 2 21\n ...\n chr2 N2 20\n\nwhere the first column stored the chromosome name, the second is the position\nand the third is the coverage itself. See sequana_coverage documentation for\ndetails. If you have BAM files as input, we will do the conversion for you. In\nsuch case, use this option::\n\n --input-pattern \"*.bam\"\n\nThe sequana_coverage script creates a directory with the pipeline and \nits configuration file. You will then need \nto execute the pipeline::\n\n cd coverage\n sh coverage.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 multicov.rules -c config.yaml --cores 4 --stats stats.txt\n\nOr use `sequanix <https://sequana.readthedocs.io/en/master/sequanix.html>`_ interface as follows::\n\n sequanix -w analysis -i . -p coverage\n\nGo to the second panel, in Input data and then in Input directory. There, you\nmust modify the pattern (empty field by default meaning search for fastq files)\nand set the field to either::\n\n *.bed\n\nor::\n\n *.bam\n\n\nYou are ready to go. Save the project and press Run. Once done, open the HTML report.\n\n\nRequirements\n~~~~~~~~~~~~\n\nThis pipelines requires the following executable(s):\n\n- sequana_coverage from **Sequana**, which should be installed automatically.\n- multiqc\n\n.. .. image:: https://raw.githubusercontent.com/sequana/multicov/master/sequana_pipelines/multicov/dag.png\n\n\nDetails\n~~~~~~~~~\n\nThis pipeline runs **coverage** in parallel on the input BAM files (or BED file). \n\n\nThe coverage tool takes as input a BAM or a BED file. The BED file must have 3\nor 4 columns as explained in the standalone application (sequana_coverage) \n`documentation <http://sequana.readthedocs.io/en/master/applications.html?highlight=coverage#sequana-coverage>`_. \nIn short, the first column is the chromosome name, the second column is the\nposition (sorted) and the third column is the coverage (an optional fourth\ncolumn would contain a coverage signal, which could be high quality coverage for\ninstance).\n\nIf you have only BAM files, you can convert them using **bioconvert** tool or\nthe command::\n\n samtools depth -aa input.bam > output.bed\n\nIf you have a CRAM file::\n\n samtools view -@ 4 -T reference.fa -b -o out.bam in.cram\n\nFor very large BAM/BED files, we recommend to split the BED file by\nchromosomes. For instance for the chromosome chr1, type::\n\n # samtools index in.bam\n samtools depth -aa input.bam -r chr1 in.bam > chr1.bed\n\nThe standalone or Snakemake application can also take as input your BAM file and\nwill convert it automatically into a BED file.\n\n\nRules and configuration details\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nHere is the `latest documented configuration file <https://raw.githubusercontent.com/sequana/multicov/main/sequana_pipelines/multicov/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.1.0 * set apptainer containers and use wrappers\n1.0.0 * renamed into multicov.\n * update to use latest sequana_pipetools (v0.9.2)\n0.9.1 * rename genbank field into annotation, window into window_size\n0.9.0 * first version\n========= ====================================================================",
"bugtrack_url": null,
"license": "new BSD",
"summary": "Parallelise version of sequana_coverage standalone application.",
"version": "1.1.1",
"project_urls": {
"Homepage": "https://github.com/sequana/"
},
"split_keywords": [
"coverage",
" snakemake",
" sequana",
" running median",
" cnv",
" depltion"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eccff56b129a3b394996bda36eaaede4929624400fe93bc1533e57dd6302790a",
"md5": "b94c6436fe24205048d5e5f2c145f97c",
"sha256": "9395bc5c49a7e72a9cde54362cf17d31b9bca64ad554c366de6f4d2ede2159d7"
},
"downloads": -1,
"filename": "sequana_multicov-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "b94c6436fe24205048d5e5f2c145f97c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 50849,
"upload_time": "2023-05-23T21:28:34",
"upload_time_iso_8601": "2023-05-23T21:28:34.017634Z",
"url": "https://files.pythonhosted.org/packages/ec/cf/f56b129a3b394996bda36eaaede4929624400fe93bc1533e57dd6302790a/sequana_multicov-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-23 21:28:34",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sequana-multicov"
}
JSON