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 GRCh38combine_scorefile: Combine multiple scoring files into a single scoring file in 'long' formatmatch_variants: Match target variants (bim or pvar files) against the output ofcombine_scorefileto produce scoring files for plink 2validate_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.
Release files for pgscatalog-utils 0.3.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pgscatalog_utils-0.3.1.tar.gz | 49.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pgscatalog_utils-0.3.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 113.1 kB
Release files / pgscatalog_utils-0.3.1.tar.gz
| Download URL | pgscatalog_utils-0.3.1.tar.gz |
|---|---|
| Size | 49.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7cfd18c32ee942199466b40cefb42c2b46a1836b77e247c862d32193821f67c3
|
|
BLAKE2b-256 checksum How to use checksums |
9c5353c16e82bc227f922c49130d91bcaf8c2f52536eb5032a32a2622c2f6f21
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.3.2 CPython/3.11.1 Darwin/22.2.0
|
Release files / pgscatalog_utils-0.3.1-py3-none-any.whl
| Download URL | pgscatalog_utils-0.3.1-py3-none-any.whl |
|---|---|
| Size | 63.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9d2988115baa1f9b7706f715374785ef3906c264f9c86fb9ab054ef3f6b1d5aa
|
|
BLAKE2b-256 checksum How to use checksums |
1a715d8d6d1d48b01ad4c042b171fc5d7cd287070f1fabe699fb445c2fd3eb30
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.3.2 CPython/3.11.1 Darwin/22.2.0
|
