variantcalling
Nextflow DSL2 pipeline to call variants on long read alignment.
Science Score: 65.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 10 DOI reference(s) in README -
○Academic publication links
-
○Academic email domains
-
✓Institutional organization owner
Organization sanger-tol has institutional domain (www.sanger.ac.uk) -
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.0%) to scientific vocabulary
Keywords
Repository
Nextflow DSL2 pipeline to call variants on long read alignment.
Basic Info
- Host: GitHub
- Owner: sanger-tol
- License: mit
- Language: Nextflow
- Default Branch: main
- Homepage: https://pipelines.tol.sanger.ac.uk/variantcalling
- Size: 3.96 MB
Statistics
- Stars: 8
- Watchers: 8
- Forks: 9
- Open Issues: 12
- Releases: 11
Topics
Metadata Files
README.md
Introduction
sanger-tol/variantcalling is a bioinformatics best-practice analysis pipeline for variant calling using DeepVariant for PacBio 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!
On release, automated continuous integration tests run the pipeline on a full-sized dataset on the LSF infrastructure. This ensures that the pipeline runs on LSF, has sensible resource allocation defaults set to run on real-world datasets, and permits the persistent storage of results to benchmark between pipeline releases and other analysis sources.
Pipeline summary
The pipeline takes aligned or unaligned PacBio sample reads (CRAM/BAM files) from a CSV file and the reference file in FASTA format, and then uses DeepVariant tool to make variant calling.
Steps involved:
- Split fasta file into smaller files, normally one sequence per file unless the sequences are too small.
- Align the reads if not aligned.
- Merge input BAM/CRAM files together if they have the same sample names.
- Filter out reads using the
-F 0x900option to only retain the primary alignments. - Run DeepVariant using filtered BAM/CRAM files against each of split fasta files.
- Merge all VCF and GVCF files generated by DeepVariant by sample together for each input BAM/CRAM file.
- Run VCFtools to calculate heterozygosity and per site nucleotide diversity.

Quick Start
Install
Nextflow(>=23.10.1)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:
```bash
# for aligned reads
nextflow run sanger-tol/variantcalling -profile test,YOURPROFILE --outdir
# for unaligned reads
nextflow run sanger-tol/variantcalling -profile test_align,YOURPROFILE --outdir
```
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!
bash
nextflow run sanger-tol/variantcalling --input samplesheet.csv --outdir <OUTDIR> --fasta genome.fasta.gz -profile <docker/singularity/podman/shifter/charliecloud/conda/institute>
Credits
sanger-tol/variantcalling was originally written by Guoying Qi.
We thank the following people for their extensive assistance in the development of this pipeline:
- Priyanka Surana for the pipeline design, code review and Nextflow technical supports.
- Matthieu Muffato for the pipeline design, code review and Nextflow technical supports.
We also acknowledge the work of Damon-Lee Pointon for attempting to create an short read variant calling subworkflow.
Contributions and Support
If you would like to contribute to this pipeline, please see the contributing guidelines.
For further information or help, don't hesitate to get in touch on the Slack #pipelines channel. Please create an issue on GitHub if you are not on the Sanger slack channel.
Citations
If you use sanger-tol/variantcalling for your analysis, please cite it using the following doi: 10.5281/zenodo.7890527
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.
Owner
- Name: Tree of Life programme
- Login: sanger-tol
- Kind: organization
- Location: United Kingdom
- Website: https://www.sanger.ac.uk/programme/tree-of-life/
- Twitter: sangertol
- Repositories: 15
- Profile: https://github.com/sanger-tol
The Tree of Life Programme investigates the diversity of complex organisms (eukaryotes) through sequencing and cellular technology
Citation (CITATION.cff)
authors:
- affiliation: Universidade Federal do Rio Grande do Norte
family-names: Apolonio de Amorim
given-names: Julia
orcid: https://orcid.org/0000-0002-8539-527X
website: https://github.com/juliaapolonio
- affiliation: Wellcome Sanger Institute
email: tc25@sanger.ac.uk
family-names: Chafin
given-names: Tyler
orcid: https://orcid.org/0000-0001-8687-5905
website: https://github.com/tkchafin
- affiliation: Wellcome Sanger Institute
family-names: "Ho\xE0ng"
given-names: "H\u1EA1nh"
orcid: https://orcid.org/0009-0008-6911-9903
website: https://github.com/sainsachiko
- affiliation: Wellcome Sanger Institute
email: mm49@sanger.ac.uk
family-names: Muffato
given-names: Matthieu
orcid: https://orcid.org/0000-0002-7860-3560
website: https://github.com/muffato
- affiliation: Wellcome Sanger Institute
email: 729395+gq1@users.noreply.github.com
family-names: Qi
given-names: Guoying
orcid: https://orcid.org/0000-0003-1262-8973
website: https://github.com/gq1
- affiliation: Wellcome Sanger Institute
email: ps22@sanger.ac.uk
family-names: Surana
given-names: Priyanka
orcid: https://orcid.org/0000-0002-7167-0875
website: https://github.com/priyanka-surana
- affiliation: Wellcome Sanger Institute
email: naranbjg@gmail.com
family-names: Zhang
given-names: Yunjia
orcid: https://orcid.org/0000-0001-7029-0785
website: https://github.com/yz533cb
cff-version: 1.2.0
date-released: "2025-06-25"
doi: 10.5281/zenodo.7890527
license: MIT
message: If you use this software, please cite it using the metadata from this file
and all references from CITATIONS.md .
repository-code: https://github.com/sanger-tol/variantcalling
title: sanger-tol/variantcalling v1.1.7 - Shang Tang (patch 7)
type: software
url: https://pipelines.tol.sanger.ac.uk/variantcalling
version: 1.1.7
GitHub Events
Total
- Create event: 24
- Release event: 5
- Issues event: 13
- Watch event: 6
- Delete event: 23
- Member event: 2
- Issue comment event: 67
- Push event: 96
- Pull request review comment event: 22
- Pull request review event: 39
- Pull request event: 51
- Fork event: 6
Last Year
- Create event: 24
- Release event: 5
- Issues event: 13
- Watch event: 6
- Delete event: 23
- Member event: 2
- Issue comment event: 67
- Push event: 96
- Pull request review comment event: 22
- Pull request review event: 39
- Pull request event: 51
- Fork event: 6
Issues and Pull Requests
Last synced: 4 months ago
All Time
- Total issues: 14
- Total pull requests: 29
- Average time to close issues: 8 months
- Average time to close pull requests: 4 days
- Total issue authors: 4
- Total pull request authors: 8
- Average comments per issue: 1.64
- Average comments per pull request: 1.62
- Merged pull requests: 17
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 6
- Pull requests: 24
- Average time to close issues: 2 months
- Average time to close pull requests: 6 days
- Issue authors: 3
- Pull request authors: 8
- Average comments per issue: 0.5
- Average comments per pull request: 1.33
- Merged pull requests: 13
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- muffato (12)
- gq1 (4)
- tkchafin (1)
- yz533cb (1)
- priyanka-surana (1)
Pull Request Authors
- tkchafin (11)
- gq1 (9)
- yz533cb (6)
- sainsachiko (3)
- muffato (3)
- Omabekee (1)
- sanger-tolsoft (1)
- juliaapolonio (1)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- nf-core/tower-action v3 composite
- nf-core/tower-action v3 composite
- mshick/add-pr-comment v1 composite
- actions/checkout v2 composite
- actions/checkout v2 composite
- actions/setup-node v2 composite
- actions/setup-python v1 composite
- actions/upload-artifact v2 composite
- dawidd6/action-download-artifact v2 composite
- marocchino/sticky-pull-request-comment v2 composite
