# ![nf-core/mnaseseq](docs/images/nf-core-mnaseseq_logo.png) [![GitHub Actions CI Status](https://github.com/nf-core/mnaseseq/workflows/nf-core%20CI/badge.svg)](https://github.com/nf-core/mnaseseq/actions) [![GitHub Actions Linting Status](https://github.com/nf-core/mnaseseq/workflows/nf-core%20linting/badge.svg)](https://github.com/nf-core/mnaseseq/actions) [![Nextflow](https://img.shields.io/badge/nextflow-%E2%89%A519.10.0-brightgreen.svg)](https://www.nextflow.io/) [![install with bioconda](https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg)](http://bioconda.github.io/) [![Docker](https://img.shields.io/docker/automated/nfcore/mnaseseq.svg)](https://hub.docker.com/r/nfcore/mnaseseq) ## Introduction **nfcore/mnaseseq** is a bioinformatics analysis pipeline used for DNA sequencing data obtained via micrococcal nuclease digestion. The pipeline is built using [Nextflow](https://www.nextflow.io), a workflow tool to run tasks across multiple compute infrastructures in a very portable manner. It comes with docker containers making installation trivial and results highly reproducible. ## Pipeline summary 1. Raw read QC ([`FastQC`](https://www.bioinformatics.babraham.ac.uk/projects/fastqc/)) 2. Adapter trimming ([`Trim Galore!`](https://www.bioinformatics.babraham.ac.uk/projects/trim_galore/)) 3. Alignment ([`BWA`](https://sourceforge.net/projects/bio-bwa/files/)) 4. Mark duplicates ([`picard`](https://broadinstitute.github.io/picard/)) 5. Merge alignments from multiple libraries of the same sample ([`picard`](https://broadinstitute.github.io/picard/)) 1. Re-mark duplicates ([`picard`](https://broadinstitute.github.io/picard/)) 2. Filtering to remove: * reads mapping to blacklisted regions ([`SAMtools`](https://sourceforge.net/projects/samtools/files/samtools/), [`BEDTools`](https://github.com/arq5x/bedtools2/)) * reads that are marked as duplicates ([`SAMtools`](https://sourceforge.net/projects/samtools/files/samtools/)) * reads that arent marked as primary alignments ([`SAMtools`](https://sourceforge.net/projects/samtools/files/samtools/)) * reads that are unmapped ([`SAMtools`](https://sourceforge.net/projects/samtools/files/samtools/)) * reads that map to multiple locations ([`SAMtools`](https://sourceforge.net/projects/samtools/files/samtools/)) * reads containing > 4 mismatches ([`BAMTools`](https://github.com/pezmaster31/bamtools)) * reads that are soft-clipped ([`BAMTools`](https://github.com/pezmaster31/bamtools)) * reads that have an insert size within specified range ([`BAMTools`](https://github.com/pezmaster31/bamtools); *paired-end only*) * reads that map to different chromosomes ([`Pysam`](http://pysam.readthedocs.io/en/latest/installation.html); *paired-end only*) * reads that arent in FR orientation ([`Pysam`](http://pysam.readthedocs.io/en/latest/installation.html); *paired-end only*) * reads where only one read of the pair fails the above criteria ([`Pysam`](http://pysam.readthedocs.io/en/latest/installation.html); *paired-end only*) 3. Alignment-level QC and estimation of library complexity ([`picard`](https://broadinstitute.github.io/picard/), [`Preseq`](http://smithlabresearch.org/software/preseq/)) 4. Create normalised bigWig files scaled to 1 million mapped reads ([`BEDTools`](https://github.com/arq5x/bedtools2/), [`bedGraphToBigWig`](http://hgdownload.soe.ucsc.edu/admin/exe/)) 5. Calculate genome-wide coverage assessment ([`deepTools`](https://deeptools.readthedocs.io/en/develop/content/tools/plotFingerprint.html)) 6. Call nucleosome positions and generate smoothed, normalised coverage bigWig files that can be used to generate occupancy profile plots between samples across features of interest ([`DANPOS2`](https://sites.google.com/site/danposdoc/)) 7. Generate gene-body meta-profile from DANPOS2 smoothed bigWig files ([`deepTools`](https://deeptools.readthedocs.io/en/develop/content/tools/plotProfile.html)) 6. Merge filtered alignments across replicates ([`picard`](https://broadinstitute.github.io/picard/)) 1. Re-mark duplicates ([`picard`](https://broadinstitute.github.io/picard/)) 2. Remove duplicate reads ([`SAMtools`](https://sourceforge.net/projects/samtools/files/samtools/)) 3. Create normalised bigWig files scaled to 1 million mapped reads ([`BEDTools`](https://github.com/arq5x/bedtools2/), [`wigToBigWig`](http://hgdownload.soe.ucsc.edu/admin/exe/)) 4. Call nucleosome positions and generate smoothed, normalised coverage bigWig files that can be used to generate occupancy profile plots between samples across features of interest ([`DANPOS2`](https://sites.google.com/site/danposdoc/)) 5. Generate gene-body meta-profile from DANPOS2 smoothed bigWig files ([`deepTools`](https://deeptools.readthedocs.io/en/develop/content/tools/plotProfile.html)) 7. Create IGV session file containing bigWig tracks for data visualisation ([`IGV`](https://software.broadinstitute.org/software/igv/)). 8. Present QC for raw read and alignment results ([`MultiQC`](http://multiqc.info/)) ## Quick Start i. Install [`nextflow`](https://nf-co.re/usage/installation) ii. Install either [`Docker`](https://docs.docker.com/engine/installation/) or [`Singularity`](https://www.sylabs.io/guides/3.0/user-guide/) for full pipeline reproducibility (please only use [`Conda`](https://conda.io/miniconda.html) as a last resort; see [docs](https://nf-co.re/usage/configuration#basic-configuration-profiles)) iii. Download the pipeline and test it on a minimal dataset with a single command ```bash nextflow run nf-core/mnaseseq -profile test, ``` > Please check [nf-core/configs](https://github.com/nf-core/configs#documentation) to see if a custom config file to run nf-core pipelines already exists for your Institute. If so, you can simply use `-profile ` in your command. This will enable either `docker` or `singularity` and set the appropriate execution settings for your local compute environment. iv. Start running your own analysis! ```bash nextflow run nf-core/mnaseseq -profile --input design.csv --genome GRCh37 ``` See [usage docs](docs/usage.md) for all of the available options when running the pipeline. ## Documentation The nf-core/mnaseseq pipeline comes with documentation about the pipeline, found in the `docs/` directory: 1. [Installation](https://nf-co.re/usage/installation) 2. Pipeline configuration * [Local installation](https://nf-co.re/usage/local_installation) * [Adding your own system config](https://nf-co.re/usage/adding_own_config) * [Reference genomes](https://nf-co.re/usage/reference_genomes) 3. [Running the pipeline](docs/usage.md) 4. [Output and how to interpret the results](docs/output.md) 5. [Troubleshooting](https://nf-co.re/usage/troubleshooting) ## Credits The pipeline was originally written by [The Bioinformatics & Biostatistics Group](https://www.crick.ac.uk/research/science-technology-platforms/bioinformatics-and-biostatistics/) for use at [The Francis Crick Institute](https://www.crick.ac.uk/), London. The pipeline was developed by [Harshil Patel](mailto:harshil.patel@crick.ac.uk). Many thanks to others who have helped out along the way too, including (but not limited to): [@crickbabs](https://github.com/crickbabs). ## Contributions and Support If you would like to contribute to this pipeline, please see the [contributing guidelines](.github/CONTRIBUTING.md). For further information or help, don't hesitate to get in touch on [Slack](https://nfcore.slack.com/channels/mnaseseq) (you can join with [this invite](https://nf-co.re/join/slack)). ## Citation You can cite the `nf-core` publication as follows: > **The nf-core framework for community-curated bioinformatics pipelines.** > > Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso & Sven Nahnsen. > > _Nat Biotechnol._ 2020 Feb 13. doi: [10.1038/s41587-020-0439-x](https://dx.doi.org/10.1038/s41587-020-0439-x). > ReadCube: [Full Access Link](https://rdcu.be/b1GjZ) An extensive list of references for the tools used by the pipeline can be found in the [`CITATIONS.md`](CITATIONS.md) file.