YTLogos / gnomad-sv-pipeline

Code and custom scripts relevant to gnomAD-SV (Collins*, Brand*, et al., 2020)

Home Page:https://broad.io/gnomad_sv

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

gnomAD-SV codebase

Copyright (c) 2019-2020, Ryan L. Collins and the Talkowski Laboratory.
Distributed under terms of the MIT License (see LICENSE).


IMPORTANT NOTE (PLEASE READ)

As of June 18, 2020, the SV discovery pipeline used for gnomAD-SV and described in Collins*, Brand*, et al., Nature (2020) has been refactored & extensively documented, and is now provided in a different repository.

Please refer to the updated codebase here if you are interested in running the SV discovery pipeline as applied to gnomAD-SV.

This old repository will be preserved for archival purposes; however, please note that no active development is underway.

Please report all issues, feature requests, etc. in the new GATK-SV repo.


Structure of this repository

The contents of this codebase are subdivided into several sections, for clarity.

These sections are subdivided as follows:

SV pipeline WDLs

Directory: gnomad_sv_pipeline_wdls

This subdirectory contains the WDLs used to generate SV callsets using the gnomAD-SV pipeline.

If you are unfamiliar with WDL, please see the Dependencies section below for more information.

Each task within each WDL specifies a publicly readable Docker image; these Docker images contain the scripts required to run each task. These scripts need not be called individually; they have all been placed in the appropriate order and with the correct arguments & options within their corresponding WDLs.

gnomAD-SV analysis scripts

Directory: gnomad_sv_analysis_scripts

This subdirectory contains the individual scripts and custom code used to filter, perform quality-control on, and analyze the gnomAD-SV callset on FireCloud.

gnomAD-SV analysis WDLs

Directory: gnomad_sv_analysis_wdls

This subdirectory contains the WDLs used to filter, perform quality-control on, and analyze the gnomAD-SV callset on FireCloud.

gnomAD-SV manuscript code

Directory: gnomad_sv_manuscript_code

This subdirectory contains the individual scripts and custom code used to conduct the final analyses presented in the gnomAD-SV preprint, and to generate the graphs and other plots presented in the manuscript.

Please note that due to certain datasets appearing under restricted access (such as individual-level genotype data), not every analysis or plot will be able to be reproduced using the code provided herein.

Ancillary data and reference files

Directory: data_and_refs

This subdirectory contains miscellaneous data and reference files used throughout the gnomAD-SV callset generation, analysis, and manuscript preparation.


Important notes regarding the design & implementation of the gnomAD-SV discovery pipeline

  1. As described in the supplementary information provided with the gnomAD-SV preprint, the gnomAD-SV discovery pipeline has been written for cloud-based implementation via FireCloud on large (>500-sample) cohorts of standard Illumina short-read whole-genome sequencing data. As such, this pipeline was not designed to be executed on local networks or computing clusters, on smaller cohorts (<500 samples), or on sequencing data types other than standard Illumina short-read whole-genome sequencing (e.g., this pipeline will not work for exome sequencing, PacBio/Nanopore long-read sequencing, etc.).

  2. Please note that we are in the process of optimizing and refactoring the code involved in the gnomAD SV discovery pipeline to make it more streamlined and efficient for application to other datasets. We anticipate this optimized version will be available soon. Once available, it will be linked here, and will supercede all code herein.


Dependencies

  • Most of the components of this codebase are assigned to a Docker image, and in many cases image hashes are specified in the relevant WDLs that invoke each script.

  • All code has been designed & implemented for FireCloud, a user-friendly interface for large-scale parallel computation and genomics projects in Google Cloud. For more information on FireCloud, please refer to the FireCloud website.

  • FireCloud uses the Workflow Description Language (WDL) and the Cromwell Engine to interface directly with Google Cloud.

  • Many operations in the gnomAD-SV pipeline rely on svtk, a python package that handles operations with SVs in VCF and BED formats. Source code and installation instructions for svtk are provided via gitHub. More details on svtk can be found in Werling et al., Nat. Genet. (2018).


Other information

Data Availability

To browse the gnomAD-SV callset, please refer to the gnomAD Browser.

The gnomAD-SV callset is available for download in VCF and BED format, with no restrictions on reuse or reanalysis. To download these files, please visit the gnomAD website downloads page.

Consistent with all prior ExAC and gnomAD studies, the majority of raw sequencing data are available to approved investigators through various repositories such as dbGaP, etc. Access to the raw sequencing data is handled by the investigators of each contributing study, not through gnomAD directly. For details on sequencing data access, please refer to the gnomAD flagship manuscript

Terms of Use

All code in this repository is released under the MIT license (see LICENSE).

If you reuse the code hosted in this repo, or the SV data hosted on the gnomAD Browser, please cite the gnomAD-SV preprint.

Citation

A structural variation reference for medical and population genetics. Ryan L. Collins, Harrison Brand, Konrad J. Karczewski, Xuefang Zhao, Jessica Alföldi, Laurent C. Francioli, Amit V. Khera, Chelsea Lowther, Laura D. Gauthier, Harold Wang, Nicholas A. Watts, Matthew Solomonson, Anne O’Donnell-Luria, Alexander Baumann, Ruchi Munshi, Mark Walker, Christopher W. Whelan, Yongqing Huang, Ted Brookings, Ted Sharpe, Matthew R. Stone, Elise Valkanas, Jack Fu, Grace Tiao, Kristen M. Laricchia, Valentin Ruano-Rubio, Christine Stevens, Namrata Gupta, Caroline Cusick, Lauren Margolin, Genome Aggregation Database Production Team, Genome Aggregation Database Consortium, Kent D. Taylor, Henry J. Lin, Stephen S. Rich, Wendy S. Post, Yii-Der Ida Chen, Jerome I. Rotter, Chad Nusbaum, Anthony Philippakis, Eric Lander, Stacey Gabriel, Benjamin M. Neale, Sekar Kathiresan, Mark J. Daly, Eric Banks, Daniel G. MacArthur & Michael E. Talkowski. Nature (2020). DOI: 10.1038/s41586-020-2287-8. PMID: 32461652.

Credits

Acknowledgements & credits for all members of the gnomAD consoritum and gnomAD production, analysis, and SV teams are listed on the gnomAD website.

About

Code and custom scripts relevant to gnomAD-SV (Collins*, Brand*, et al., 2020)

https://broad.io/gnomad_sv

License:MIT License


Languages

Language:R 61.7%Language:WDL 32.0%Language:Python 6.2%Language:Shell 0.1%