gdtbioinfo-nf-mosaicism
Pipeline for detection of mosaicism
Science Score: 57.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
Found .zenodo.json file -
✓DOI references
Found 4 DOI reference(s) in README -
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (10.0%) to scientific vocabulary
Repository
Pipeline for detection of mosaicism
Basic Info
- Host: GitHub
- Owner: CIBERER
- License: mit
- Language: Nextflow
- Default Branch: main
- Size: 18.6 MB
Statistics
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 41
- Releases: 2
Metadata Files
README.md
Introduction
CIBERER/GdTBioinfo-nf-mosaicism is a bioinformatics best-practice analysis pipeline for detection of mosaicism through NGS data.
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! 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 uses two variant callers to detect low frequency variants, VarScan and VarDict. The result file is a VCF file obtained after intersecting the two VCF files.
- VarScan (
VarScan)
1.1. Sorting BAM file (Samtools)
1.2. Obtaining mpileup file (Samtools)
1.3. Variant Calling (VarScan)
- VarDict (
VarDictJava)
2.1. Variant Calling (VarDictJava)
- Mutect2 (Mutect2)
3.1 Generate reference sequence dictionary (CreateSequenceDictionary)
3.2 Variant Calling (Mutect2)
- Intersection of the three VCF files (
Bedtools)
Quick Start
Install
Nextflow(>=21.10.3)Install any of
Docker,Singularity(you can follow this tutorial),Podman,ShifterorCharliecloudfor full pipeline reproducibility (you can useCondaboth to install Nextflow itself and also to manage software within pipelines. Please only use it within pipelines as a last resort; see docs).Download the pipeline and test it on a minimal dataset with a single command:
console
nextflow pull CIBERER/GdTBioinfo-nf-mosaicism
nextflow run CIBERER/GdTBioinfo-nf-mosaicism -profile test,YOURPROFILE --outdir <OUTDIR>
Then, download the profile_test.md5 file, locate it in the root folder and run the next command:
console
md5sum -c profile_test.md5
If the output is like this, everything is working fine!:
console
./results/join/Sample_zenodo_T1.vcf: OK
./results/mutect2/Sample_zenodo_T1.mutect2.vcf.gz: OK
./results/mutect2/Sample_zenodo_T1.mutect2.vcf.gz.stats: OK
./results/mutect2/Sample_zenodo_T1.mutect2.vcf.gz.tbi: OK
./results/vardictjava/Sample_zenodo_T1.mpileup: OK
./results/vardictjava/Sample_zenodo_T1.txt.gz: OK
./results/vardictjava/Sample_zenodo_T1..vcf.gz: OK
./results/varscan/Sample_zenodo_T1.v2.vcf.gz: OK
Note that some form of configuration will be needed so that Nextflow knows how to fetch the required software. This is usually done in the form of a config profile (YOURPROFILE in the example command above). You can chain multiple config profiles in a comma-separated string.
- The pipeline comes with config profiles called
docker,singularity,podman,shifter,charliecloudandcondawhich instruct the pipeline to use the named tool for software management. For example,-profile test,docker.- Please check nf-core/configs to see if a custom config file to run nf-core pipelines already exists for your Institute. If so, you can simply use
-profile <institute>in your command. This will enable eitherdockerorsingularityand set the appropriate execution settings for your local compute environment.- If you are using
singularity, please use thenf-core downloadcommand to download images first, before running the pipeline. Setting theNXF_SINGULARITY_CACHEDIRorsingularity.cacheDirNextflow options enables you to store and re-use the images from a central location for future pipeline runs.- If you are using
conda, it is highly recommended to use theNXF_CONDA_CACHEDIRorconda.cacheDirsettings to store the environments in a central location for future pipeline runs.
- Start running your own analysis!
<!-- TODO nf-core: Update the example "typical command" below used to run the pipeline -->
console
nextflow run CIBERER/GdTBioinfo-nf-mosaicism --input path/to/samplesheet.csv --outdir <OUTDIR> --fasta path/to/reference/genome.fa --fai path/to/reference/genome.fa.fai --chrom_sizes path/to/referece/chrom.sizes --germline_resource path/to/population/germline_resource.vcf.gz --germline_resource_tbi path/to/population/germline_resource.vcf.gz.tbi -profile <docker/singularity/podman/shifter/charliecloud/conda/institute>
Documentation
The CIBERER-pipelines /mosaicism pipeline comes with documentation about the pipeline usage, parameters and output.
Credits
This pipeline was originally written by Carlos Ruiz, Marta Sevilla and Yolanda Benítez at the Centro de Investigaciones Biomédicas en Red de Enfermedades Raras, CIBERER.
Main authors:
Contributions and Support
If you would like to contribute to this pipeline, please contact with:
carlos.ruiza@upf.edu, marta.sevilla@upf.edu or yolanda.benitez@ciberer.es
<!-- For further information or help, don't hesitate to get in touch on the Slack #mosaicism channel (you can join with this invite).
-->
Citations
- VarScan (
VarScan) - Samtools (
Samtools) - VarDictJava (
VarDictJava) - Mutect2 (GATK)
- Bedtools
Bedtools - Tabix(
Tabix)
An extensive list of references for the tools used by the pipeline can be found in the CITATIONS.md file.
This pipeline uses code and infrastructure developed and maintained by the nf-core community, reused here under the MIT license.
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. In addition, references of tools and data used in this pipeline are as follows:
Owner
- Name: CIBERER
- Login: CIBERER
- Kind: organization
- Location: Spain
- Repositories: 1
- Profile: https://github.com/CIBERER
Citation (CITATIONS.md)
# CIBERER/GdTBioinfo-nf-mosaicism: Citations This pipeline uses code and infrastructure developed and maintained by the [nf-core](https://nf-co.re) initative, and reused here under the [MIT license](https://github.com/nf-core/tools/blob/master/LICENSE). > 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. In addition, references of tools and data used in this pipeline are as follows: ## [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 1. VarScan ([`VarScan`](https://varscan.sourceforge.net/)) >Koboldt, D., Zhang, Q., Larson, D., Shen, D., McLellan, M., Lin, L., Miller, C., Mardis, E., Ding, L., & Wilson, R. (2012). VarScan 2: Somatic mutation and copy number alteration discovery in cancer by exome sequencing Genome Research DOI: 10.1101/gr.129684.111 2. Samtools ([`Samtools`](http://www.htslib.org/)) >Twelve years of SAMtools and BCFtools Petr Danecek, James K Bonfield, Jennifer Liddle, John Marshall, Valeriu Ohan, Martin O Pollard, Andrew Whitwham, Thomas Keane, Shane A McCarthy, Robert M Davies, Heng Li GigaScience, Volume 10, Issue 2, February 2021, giab008, https://doi.org/10.1093/gigascience/giab008 3. VarDictJava ([`VarDictJava`](https://github.com/AstraZeneca-NGS/VarDictJava)) > Lai Z, Markovets A, Ahdesmaki M, Chapman B, Hofmann O, McEwen R, Johnson J, Dougherty B, Barrett JC, and Dry JR. VarDict: a novel and versatile variant caller for next-generation sequencing in cancer research. Nucleic Acids Res. 2016, pii: gkw227. 4. Mutect2 [GATK](https://www.oreilly.com/library/view/genomics-in-the/9781491975183/) > Van der Auwera GA & O'Connor BD. (2020). Genomics in the Cloud: Using Docker, GATK, and WDL in Terra (1st Edition). O'Reilly Media. 4. Bedtools [`Bedtools`](https://bedtools.readthedocs.io/en/latest/) > Aaron R. Quinlan, Ira M. Hall, BEDTools: a flexible suite of utilities for comparing genomic features, Bioinformatics, Volume 26, Issue 6, 15 March 2010, Pages 841–842, https://doi.org/10.1093/bioinformatics/btq033 5. Tabix([`Tabix`](http://www.htslib.org/doc/tabix.html)) > Heng Li, Bob Handsaker, Alec Wysoker, Tim Fennell, Jue Ruan, Nils Homer, Gabor Marth, Goncalo Abecasis, Richard Durbin, 1000 Genome Project Data Processing Subgroup, The Sequence Alignment/Map format and SAMtools, Bioinformatics, Volume 25, Issue 16, 15 August 2009, Pages 2078–2079, https://doi.org/10.1093/bioinformatics/btp352 ## 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.
GitHub Events
Total
- Issue comment event: 5
- Push event: 5
- Pull request review event: 1
- Pull request event: 1
- Create event: 2
Last Year
- Issue comment event: 5
- Push event: 5
- Pull request review event: 1
- Pull request event: 1
- Create event: 2
