Coder Social home page Coder Social logo

nservant / sarek Goto Github PK

View Code? Open in Web Editor NEW

This project forked from nf-core/sarek

0.0 1.0 0.0 37.59 MB

Detect germline or somatic variants from normal or tumour/normal whole-genome sequencing data

Home Page: http://opensource.scilifelab.se/projects/sarek/

License: MIT License

Nextflow 50.21% R 25.64% Python 13.21% Shell 6.95% Groovy 2.62% Awk 1.37%

sarek's Introduction

Sarek

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

sarek version Travis status nextflow version License DOI Join the chat at https://gitter.im/SciLifeLab/Sarek

Introduction

Previously known as the Cancer Analysis Workflow (CAW), Sarek is a workflow tool 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 bioinformatics 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)
    • Read alignment
    • Read realignment and recalibration of short-read data
  2. Germline variant calling - germlineVC.nf
  3. Somatic variant calling - somaticVC.nf (optional)
  4. Annotation - annotate.nf (optional)
    • Variant annotation
  5. Reporting - runMultiQC.nf

Documentation

The Sarek pipeline comes with documentation in the doc/ 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. Examples
  10. TSV file documentation
  11. Processes documentation
  12. Documentation about containers
  13. Documentation about building
  14. More information about ASCAT
  15. Folder 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: [email protected], [email protected]

CHANGELOG

Authors


SciLifeLab NGI NBIS

sarek's People

Contributors

maxulysse avatar marcelm avatar pallolason avatar j35p312 avatar ewels avatar pditommaso avatar malinlarsson avatar sebastian-d avatar waffle-iron avatar arontommi avatar

Watchers

Nicolas Servant avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.