PGS Catalog utilities

This repository is a collection of useful tools for downloading and working with scoring files from the PGS Catalog. This is mostly used internally by the PGS Catalog Calculator (PGScatalog/pgsc_calc); however, other users may find some of these tools helpful.

Overview

download_scorefiles: Download scoring files by PGS ID (accession) in genome builds GRCh37 or GRCh38
combine_scorefile: Combine multiple scoring files into a single scoring file in 'long' format
match_variants: Match target variants (bim or pvar files) against the output of combine_scorefile to produce scoring files for plink 2
ancestry_analysis : use genetic PCA loadings to compare samples to population reference panels, and report PGS adjusted for these axes of genetic ancestry. The PCs will likely have been generated with FRAPOSA (pgs catalog version)
validate_scorefiles: Check/validate that the scoring files and harmonized scoring files match the PGS Catalog scoring file formats.

Installation

$ pip install pgscatalog-utils

Quickstart

$ download_scorefiles -i PGS000922 PGS001229 -o . -b GRCh37
$ combine_scorefiles -s PGS*.txt.gz -o combined.txt 
$ match_variants -s combined.txt -t <example.pvar> --min_overlap 0.75 --outdir .
$ validate_scorefiles -t formatted --dir <scoringfiles_directory> --log_dir <logs_directory>

More details are available using the --help parameter.

Install from source

Requirements:

python 3.10
poetry

$ git clone https://github.com/PGScatalog/pgscatalog_utils.git
$ cd pgscatalog_utils
$ poetry install
$ poetry build
$ pip install --user dist/*.whl

Credits

The pgscatalog_utils package is developed as part of the Polygenic Score (PGS) Catalog (www.PGSCatalog.org) project, a collaboration between the University of Cambridge’s Department of Public Health and Primary Care (Michael Inouye, Samuel Lambert, Laurent Gil) and the European Bioinformatics Institute (Helen Parkinson, Aoife McMahon, Ben Wingfield, Laura Harris).

A manuscript describing the tool and larger PGS Catalog Calculator pipeline (PGSCatalog/pgsc_calc) is in preparation. In the meantime if you use these tools we ask you to cite the repo(s) and the paper describing the PGS Catalog resource:

PGS Catalog utilities (in development). PGS Catalog Team. https://github.com/PGScatalog/pgscatalog_utils
PGS Catalog Calculator (in development). PGS Catalog Team. https://github.com/PGScatalog/pgsc_calc
Lambert et al. (2021) The Polygenic Score Catalog as an open database for reproducibility and systematic evaluation. Nature Genetics. 53:420–425 doi:10.1038/s41588-021-00783-5.

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.

Metadata

Release files for pgscatalog-utils 0.4.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pgscatalog-utils 0.4.2
File	Size	Uploaded
pgscatalog_utils-0.4.2.tar.gz	66.7 kB	Sep 28, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for pgscatalog-utils 0.4.2
File	Interpreter	ABI	Platform	Reset
pgscatalog_utils-0.4.2-py3-none-any.whl 86.1 kB Sep 28, 2023	Python 3	none	any	Details

Total release size: 152.8 kB

Release files / pgscatalog_utils-0.4.2.tar.gz

Download URL	pgscatalog_utils-0.4.2.tar.gz
Size	66.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`e146bc4ff5b74d6a65836ae34cf149cafcfe05be8ea0f85fefb95ec26c2368a4`
BLAKE2b-256 checksum How to use checksums	`04c05cc941714d93953abda0fc0ada1b8cf52241a1f72b6af47248b57f89443d`
Upload date	Sep 28, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.3.2 CPython/3.10.13 Linux/6.2.0-1012-azure`

Release files / pgscatalog_utils-0.4.2-py3-none-any.whl

Download URL	pgscatalog_utils-0.4.2-py3-none-any.whl
Size	86.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`128f886d059d4dfec2e8c1999005001ce46b6d9a23e4913fb92089a4813a6509`
BLAKE2b-256 checksum How to use checksums	`0cec62ee06c523c37b1243daf5299c1f356cb6d7f818950fa0cb27bb8e527436`
Upload date	Sep 28, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.3.2 CPython/3.10.13 Linux/6.2.0-1012-azure`