Detect germline or somatic variants from normal or tumour/normal whole-genome or targeted sequencing
Clone or download
Latest commit e504b0e Sep 21, 2018
Permalink
Failed to load latest commit information.
.github +s [skip ci] Sep 13, 2018
Sarek-data @ c2da0d2 Sarek-data updated Sep 11, 2018
bin putting concatenateVCF.sh to bin Sep 12, 2018
conf preparing release 2.2.0 Sep 21, 2018
containers move files Aug 21, 2018
docs Conflict resolve Sep 21, 2018
lib temporary fix for vepgrch37 container path problem Sep 12, 2018
repeats Keeping region files in sync with UPPMAX version Jun 25, 2018
scripts Zenodo tests Sep 21, 2018
.gitattributes Config files are nextflow syntax in .gitattributes Apr 5, 2018
.gitignore add tmp/ Aug 16, 2018
.gitmodules add pathfindr as a submodule Aug 21, 2018
.travis.yml simplified tests without singularity Sep 13, 2018
CHANGELOG.md preparing release 2.2.0 Sep 21, 2018
Dockerfile preparing release 2.2.0 Sep 21, 2018
LICENSE add LICENSE file Sep 23, 2016
README.md Merge branch 'dev' into master Sep 13, 2018
Singularity preparing release 2.2.0 Sep 21, 2018
annotate.nf temporary fix for vepgrch37 container path problem Sep 12, 2018
buildContainers.nf update with .simg extension for singularity image + remove --name option Sep 11, 2018
buildReferences.nf spacing Sep 10, 2018
environment.yml preparing release 2.2.0 Sep 21, 2018
germlineVC.nf added target report at the end, targetBED=false in base.config Sep 12, 2018
main.nf update processes comments and docs Sep 6, 2018
nextflow.config update base config and manifest Aug 30, 2018
runMultiQC.nf update processes comments and docs Sep 6, 2018
somaticVC.nf added target report at the end, targetBED=false in base.config Sep 12, 2018

README.md

Sarek

An open-source analysis pipeline to detect germline or somatic variants from whole genome or targeted sequencing

Nextflow version Travis build status Join the chat on https://gitter.im/SciLifeLab/Sarek

MIT License Sarek version DOI

Install with bioconda Docker Container available

Introduction

Previously known as the Cancer Analysis Workflow (CAW), Sarek is a workflow designed to run analyses on WGS data from regular samples or tumour / normal pairs, including relapse samples if required.

It's built using Nextflow, a domain specific language for workflow building. Software dependencies are handled using Docker or Singularity - container technologies that provide excellent reproducibility and ease of use. Singularity has been designed specifically for high-performance computing environments. This means that although Sarek has been primarily designed for use with the Swedish UPPMAX HPC systems, it should be able to run on any system that supports these two tools.

Sarek was developed at the National Genomics Infastructure and National Bioinformatics Infastructure Sweden which are both platforms at SciLifeLab. It is listed on the Elixir - Tools and Data Services Registry.

Workflow steps

Sarek is built with several workflow scripts. A wrapper script contained within the repository makes it easy to run the different workflow scripts as a single job. To test your installation, follow the tests documentation.

Raw FastQ files or aligned BAM files (with or without realignment & recalibration) can be used as inputs. You can choose which variant callers to use, plus the pipeline is capable of accommodating additional variant calling software or CNV callers if required.

The worflow steps and tools used are as follows:

  1. Preprocessing - main.nf (based on GATK best practices)
  2. Germline variant calling - germlineVC.nf
  3. Somatic variant calling - somaticVC.nf (optional)
  4. Annotation - annotate.nf (optional)
  5. Reporting - runMultiQC.nf

Documentation

The Sarek pipeline comes with documentation in the docs/ directory:

  1. Installation documentation
  2. Installation documentation specific for UPPMAX rackham
  3. Installation documentation specific for UPPMAX bianca
  4. Tests documentation
  5. Reference files documentation
  6. Configuration and profiles documentation
  7. Intervals documentation
  8. Running the pipeline
  9. Command line parameters
  10. Examples
  11. Input files documentation
  12. Processes documentation
  13. Documentation about containers
  14. More information about ASCAT
  15. Output documentation structure

Contributions & 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 Gitter or contact us: maxime.garcia@scilifelab.se, szilveszter.juhos@scilifelab.se

CHANGELOG

Credits

Main authors:

Helpful contributors:


SciLifeLab NGI NBIS