genome-seek 🔬

Whole Genome and Exome Clinical Sequencing Pipeline

This is the home of the pipeline, genome-seek. Its long-term goals: to accurately call germline and somatic variants, to infer SVs & CNVs, and to boldly annotate variants like no pipeline before!

Overview¶

Welcome to genome-seek's documentation! This guide is the main source of documentation for users who are getting started with the OpenOmics genome-seek pipeline.

The ./genome-seek pipeline is composed of several interrelated sub-commands to set up and run the pipeline across different systems. Each of the available sub-commands performs different functions:

genome-seek run
Run the genome-seek pipeline with your input files.

genome-seek unlock
Unlocks a previous runs output directory.

genome-seek install
Download remote reference files locally.

genome-seek cache
Cache remote software containers locally.

genome-seek is a comprehensive clinical WGS and WES pipeline that is focused on speed. Each tool in the pipeline was benchmarked and selected due to its low run times without sacrificing accuracy or precision. It relies on technologies like Singularity¹ to maintain the highest level of reproducibility. The pipeline consists of a series of data processing and quality-control steps orchestrated by Snakemake², a flexible and scalable workflow management system, to submit jobs to a cluster.

The pipeline is compatible with data generated from Illumina short-read sequencing technologies. As input, it accepts a set of FastQ files and can be run locally on a compute instance or on-premise using a cluster (recommended). A user can define the method or mode of execution. The pipeline can submit jobs to a cluster using a job scheduler like SLURM (more coming soon!). A hybrid approach ensures the pipeline is accessible to all users.

Before getting started, we highly recommend reading through the usage section of each available sub-command.

For more information about issues or troubleshooting a problem, please check out our FAQ before opening an issue on Github.

Contribute¶

This site is a living document, created for and by members like you. genome-seek is maintained by the members of NCBR and is improved by continuous feedback! We encourage you to contribute new content and make improvements to existing content via pull requests to our GitHub repository .

References¶

^{1. Kurtzer GM, Sochat V, Bauer MW (2017). Singularity: Scientific containers for mobility of compute. PLoS ONE 12(5): e0177459.}
^{2. Koster, J. and S. Rahmann (2018). "Snakemake-a scalable bioinformatics workflow engine." Bioinformatics 34(20): 3600.}

Last update: 2024-02-06