nf-core-demultiplex-methylation
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
○.zenodo.json file
-
✓DOI references
Found 7 DOI reference(s) in README -
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.6%) to scientific vocabulary
Repository
Basic Info
- Host: GitHub
- Owner: chelauk
- License: mit
- Language: Nextflow
- Default Branch: master
- Size: 2.94 MB
Statistics
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 1
- Releases: 0
Metadata Files
README.md
Introduction
nf-core/demultiplex-demultiplex is a bioinformatics best-practice analysis pipeline to optionally demultiplex fastq files run bismark against a human reference and pUC19 methylated and unmethylated controls.
The pipeline is built using Nextflow, a workflow tool to run tasks across multiple compute infrastructures in a very portable manner. It uses Docker/Singularity containers making installation trivial and results highly reproducible. The Nextflow DSL2 implementation of this pipeline uses one container per process which makes it much easier to maintain and update software dependencies. Where possible, these processes have been submitted to and installed from nf-core/modules in order to make them available to all nf-core pipelines, and to everyone within the Nextflow community!
Pipeline summary
This pipeline will process methylseq data including RRBS.
- Demultiplex if necessary (
Demultiplex) - Read QC (
FastQC) - Present QC for raw reads (
MultiQC) - Trim using RRBS specific flags with TrimGalore (
Trim Galore) - Align to reference genome with BISMARK (
bismark) - Align to fully methylated control with BISMARK (
bismark) - Align to unmethylated control with BISMARK (
bismark) - Bismark methylation extractor (
bismark) - optional: filter Bismark methylation extractor output using a bed file
- Bisulphite conversion assessment
- Post alignment QC
slurm specific instructions
Download the pipeline:
console git clone https://github.com/chelauk/nf-core-demultiplex-methylation.gitEdit your .bashrc file to set the following variables:
bash
# Set all the Singularity cache dirs to Scratch
export SINGULARITY_CACHEDIR=**/your/selected/scratch/folder/singularity_imgs**
export SINGULARITY_TMPDIR=$SINGULARITY_CACHEDIR/tmp
export SINGULARITY_LOCALCACHEDIR=$SINGULARITY_CACHEDIR/localcache
export SINGULARITY_PULLFOLDER=$SINGULARITY_CACHEDIR/pull
# match the NXF_SINGULARITY_CACHEDIR
export NXF_SINGULARITY_CACHEDIR=**/your/selected/scratch/folder/singularity_imgs**
Start running your own analysis edit a sbatch script
```bash
!/bin/bash -l
SBATCH --job-name=demultiplex
SBATCH --output=nextflow_out.txt
SBATCH --partition=master-worker
SBATCH --ntasks=1
SBATCH --time=120:00:00
nextflow run /location/of/your/nextflow_pipelines/nf-core-demultiplex-methylation \ --input input.csv \ -profile slurm,singularity \ -resume ```
Start your sbatch job:
console
sbatch runNextflow.sh
`
Documentation
The nf-core/demultiplex pipeline comes with documentation about the pipeline usage and output.
Credits
nf-core-demultiplex-methylation was originally written by Chela James
We thank the following people for their extensive assistance in the development of this pipeline:
Contributions and Support
If you would like to contribute to this pipeline, please see the contributing guidelines.
Citations
An extensive list of references for the tools used by the pipeline can be found in the CITATIONS.md file.
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.
Owner
- Name: Chela James
- Login: chelauk
- Kind: user
- Location: Milan
- Company: Fondazione Human Technopole
- Website: http://www.sottorivalab.org/
- Twitter: chelauk
- Repositories: 61
- Profile: https://github.com/chelauk
Senior Bioinformatician Fondazione Human Technopole
Citation (CITATIONS.md)
# nf-core/demultiplex: Citations
## [nf-core](https://pubmed.ncbi.nlm.nih.gov/32055031/)
> Ewels PA, Peltzer A, Fillinger S, Patel H, Alneberg J, Wilm A, Garcia MU, Di Tommaso P, Nahnsen S. The nf-core framework for community-curated bioinformatics pipelines. Nat Biotechnol. 2020 Mar;38(3):276-278. doi: 10.1038/s41587-020-0439-x. PubMed PMID: 32055031.
## [Nextflow](https://pubmed.ncbi.nlm.nih.gov/28398311/)
> Di Tommaso P, Chatzou M, Floden EW, Barja PP, Palumbo E, Notredame C. Nextflow enables reproducible computational workflows. Nat Biotechnol. 2017 Apr 11;35(4):316-319. doi: 10.1038/nbt.3820. PubMed PMID: 28398311.
## Pipeline tools
* [FastQC](https://www.bioinformatics.babraham.ac.uk/projects/fastqc/)
* [MultiQC](https://pubmed.ncbi.nlm.nih.gov/27312411/)
> Ewels P, Magnusson M, Lundin S, Käller M. MultiQC: summarize analysis results for multiple tools and samples in a single report. Bioinformatics. 2016 Oct 1;32(19):3047-8. doi: 10.1093/bioinformatics/btw354. Epub 2016 Jun 16. PubMed PMID: 27312411; PubMed Central PMCID: PMC5039924.
## Software packaging/containerisation tools
* [Anaconda](https://anaconda.com)
> Anaconda Software Distribution. Computer software. Vers. 2-2.4.0. Anaconda, Nov. 2016. Web.
* [Bioconda](https://pubmed.ncbi.nlm.nih.gov/29967506/)
> Grüning B, Dale R, Sjödin A, Chapman BA, Rowe J, Tomkins-Tinch CH, Valieris R, Köster J; Bioconda Team. Bioconda: sustainable and comprehensive software distribution for the life sciences. Nat Methods. 2018 Jul;15(7):475-476. doi: 10.1038/s41592-018-0046-7. PubMed PMID: 29967506.
* [BioContainers](https://pubmed.ncbi.nlm.nih.gov/28379341/)
> da Veiga Leprevost F, Grüning B, Aflitos SA, Röst HL, Uszkoreit J, Barsnes H, Vaudel M, Moreno P, Gatto L, Weber J, Bai M, Jimenez RC, Sachsenberg T, Pfeuffer J, Alvarez RV, Griss J, Nesvizhskii AI, Perez-Riverol Y. BioContainers: an open-source and community-driven framework for software standardization. Bioinformatics. 2017 Aug 15;33(16):2580-2582. doi: 10.1093/bioinformatics/btx192. PubMed PMID: 28379341; PubMed Central PMCID: PMC5870671.
* [Docker](https://dl.acm.org/doi/10.5555/2600239.2600241)
* [Singularity](https://pubmed.ncbi.nlm.nih.gov/28494014/)
> Kurtzer GM, Sochat V, Bauer MW. Singularity: Scientific containers for mobility of compute. PLoS One. 2017 May 11;12(5):e0177459. doi: 10.1371/journal.pone.0177459. eCollection 2017. PubMed PMID: 28494014; PubMed Central PMCID: PMC5426675.
