Workflow Type: Nextflow
Stable

The Polygenic Score Catalog Calculator (pgsc_calc)

Documentation Status pgscatalog/pgsc_calc CI DOI

Nextflow run with docker run with singularity run with conda

Introduction

pgsc_calc is a bioinformatics best-practice analysis pipeline for calculating polygenic [risk] scores on samples with imputed genotypes using existing scoring files from the Polygenic Score (PGS) Catalog and/or user-defined PGS/PRS.

Pipeline summary

The workflow performs the following steps:

  • Downloading scoring files using the PGS Catalog API in a specified genome build (GRCh37 and GRCh38).
  • Reading custom scoring files (and performing a liftover if genotyping data is in a different build).
  • Automatically combines and creates scoring files for efficient parallel computation of multiple PGS
    • Matching variants in the scoring files against variants in the target dataset (in plink bfile/pfile or VCF format)
  • Calculates PGS for all samples (linear sum of weights and dosages)
  • Creates a summary report to visualize score distributions and pipeline metadata (variant matching QC)

And optionally:

  • Genetic Ancestry: calculate similarity of target samples to populations in a reference dataset (1000 Genomes (1000G)), using principal components analysis (PCA)
  • PGS Normalization: Using reference population data and/or PCA projections to report individual-level PGS predictions (e.g. percentiles, z-scores) that account for genetic ancestry

See documentation for a list of planned features under development.

Quick start

  1. Install Nextflow (>=22.10.0)

  2. Install Docker or Singularity (v3.8.3 minimum) (please only use Conda as a last resort)

  3. Download the pipeline and test it on a minimal dataset with a single command:

    nextflow run pgscatalog/pgsc_calc -profile test,
    
  4. Start running your own analysis!

    nextflow run pgscatalog/pgsc_calc -profile  --input samplesheet.csv --pgs_id PGS001229
    

See getting started for more details.

Documentation

Full documentation is available on Read the Docs

Credits

pgscatalog/pgsc_calc is developed as part of the PGS Catalog project, a collaboration between the University of Cambridge’s Department of Public Health and Primary Care (Michael Inouye, Samuel Lambert) and the European Bioinformatics Institute (Helen Parkinson, Laura Harris).

The pipeline seeks to provide a standardized workflow for PGS calculation and ancestry inference implemented in nextflow derived from an existing set of tools/scripts developed by Inouye lab (Rodrigo Canovas, Scott Ritchie, Jingqin Wu) and PGS Catalog teams (Samuel Lambert, Laurent Gil).

The adaptation of the codebase, nextflow implementation, and PGS Catalog features are written by Benjamin Wingfield, Samuel Lambert, Laurent Gil with additional input from Aoife McMahon (EBI). Development of new features, testing, and code review is ongoing including Inouye lab members (Rodrigo Canovas, Scott Ritchie) and others. A manuscript describing the tool is in preparation. In the meantime if you use the tool we ask you to cite the repo and the paper describing the PGS Catalog resource:

This pipeline is distrubuted under an Apache License amd uses code and infrastructure developed and maintained by the nf-core community (Ewels et al. Nature Biotech (2020) doi:10.1038/s41587-020-0439-x), reused here under the MIT license.

Additional references of open-source tools and data used in this pipeline are described in CITATIONS.md.

This work has received funding from EMBL-EBI core funds, the Baker Institute, the University of Cambridge, Health Data Research UK (HDRUK), and the European Union’s Horizon 2020 research and innovation programme under grant agreement No 101016775 INTERVENE.

Version History

v2.0.0-alpha.1 (latest) Created 11th Aug 2023 at 15:30 by Samuel Lambert

v2.0.0-alpha.1 (#153)

  • fix test profile

  • change standard test to pull workflow with -r ${GITHUB_REF}

  • fix standard test

  • use local data for pytest

  • fix nextflow -r ${branch name}

  • oops

  • change report tag dev -> 2.0

  • update changelog


Frozen v2.0.0-alpha.1 28a0971

v1.3.2 Created 10th Aug 2023 at 10:10 by Samuel Lambert

add singularity to test suite


Frozen v1.3.2 bd1ca59

v2.0.0-alpha Created 10th Aug 2023 at 10:09 by Samuel Lambert

Merge pull request #135 from PGScatalog/dev

v2 release


Frozen v2.0.0-alpha af4882c

main @ d14e43e (earliest) Created 10th Aug 2023 at 10:01 by Samuel Lambert

use mamba in test


Frozen main d14e43e
help Creators and Submitter
Creators
Submitter
Activity

Views: 1075

Created: 10th Aug 2023 at 10:01

Last updated: 11th Aug 2023 at 15:30

Annotated Properties
help Attributions

None

Total size: 7.9 MB
Powered by
(v.1.14.1)
Copyright © 2008 - 2023 The University of Manchester and HITS gGmbH