Whole Genome and Exome Clinical Sequencing Pipeline.
Welcome to genome-seek! Before getting started, we highly recommend reading through genome-seek's documentation.
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 cache: Cache 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 Singularity1 to maintain the highest level of reproducibility. The pipeline consists of a series of data processing and quality-control steps orchestrated by Snakemake2, 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 or UGE (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.
Requires: singularity>=3.5 snakemake<=7.32.3
At the current moment, the pipeline only has two dependencies: snakemake and singularity/apptainer. With that being said, snakemake and (singularity or apptainer) must be installed on the target system. Snakemake orchestrates the execution of each step in the pipeline. The second dependency, i.e singularity/apptainer, handles downloading/distribution of the pipeline's software dependencies. To guarantee the highest level of reproducibility, each step of the pipeline relies on versioned images from DockerHub. Snakemake uses singularity to pull these images onto the local filesystem prior to job execution, and as so, snakemake and singularity/apptainer will be the only two dependencies in the future.
Please clone this repository to your local filesystem using the following command:
# Clone Repository from Github
git clone https://github.com/OpenOmics/genome-seek.git
# Change your working directory
cd genome-seek/
# Add dependencies to $PATH
# Biowulf users should run
module load snakemake singularity
# Get usage information
./genome-seek -hThis 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.
If you use this software, please cite it as below:
@BibText
@software{Kuhn_OpenOmics_genome-seek_2024,
author = {Kuhn, Skyler and
Lack, Justin and
Talsania, Keyur},
title = {OpenOmics/genome-seek: v0.9.0},
month = jun,
year = 2024,
publisher = {Zenodo},
version = {v0.9.0},
doi = {10.5281/zenodo.12586652},
url = {https://doi.org/10.5281/zenodo.12586652}
}
@APA
Kuhn, S., Lack, J., & Talsania, K. (2024). OpenOmics/genome-seek: v0.9.0 (v0.9.0). Zenodo. https://doi.org/10.5281/zenodo.12586652
For more citation style options, please visit the pipeline's Zenodo page.
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.