Skip to main content

Core tools for working with polygenic scores (PGS) and the PGS Catalog

Project description

pgscatalog.core

Run pytest on pgscatalog.core Documentation Status

This Python package contains:

  • CLI applications to download scoring files from the PGS Catalog and normalise them into a consistent structure
  • core library classes and functions for working with PGS data
Application Description Link
pgscatalog-download Download scoring files from the PGS Catalog in specific genome builds README
pgscatalog-combine Combine multiple scoring files into a consistent structure README
pgscatalog-relabel Relabel values in a column based on values in a column in another file README

If you want to write Python code to work with PGS data, the library may be helpful for you.

If you want to do automatic PGS calculation check out the PGS Catalog Calculator, which uses these tools internally.

Installation

install with bioconda

or install via pip:

$ pipx install pgscatalog.core

Documentation

Documentation is available at https://pygscatalog.readthedocs.io/.

Developer instructions

You'll need nox and uv installed.

To get set up with a development environment run:

$ nox -s dev
$ source .venv/bin/activate

This will create a virtual environment in the current directory.

$ pgscatalog-download --help

nox can also be used to run tests and lint the package:

$ nox

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pgscatalog_core-1.0.0.tar.gz (1.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pgscatalog_core-1.0.0-py3-none-any.whl (48.8 kB view details)

Uploaded Python 3

File details

Details for the file pgscatalog_core-1.0.0.tar.gz.

File metadata

  • Download URL: pgscatalog_core-1.0.0.tar.gz
  • Upload date:
  • Size: 1.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for pgscatalog_core-1.0.0.tar.gz
Algorithm Hash digest
SHA256 9dcc5d2e2dac23cf90b7ea50f35e482d8fd881c2e0dffe1c6a4251effe1b0d3a
MD5 c81598b3108794ee1d2bf3818e197f6f
BLAKE2b-256 7eb5d938343431b161762a4b1f2722d969f8bd2bac6348ace22ba233cbaaaf5e

See more details on using hashes here.

Provenance

The following attestation bundles were made for pgscatalog_core-1.0.0.tar.gz:

Publisher: publish.yml on PGScatalog/pygscatalog

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pgscatalog_core-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pgscatalog_core-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 342ba1a87eeba0107dc226823f71ebae441dcc0ff0a9cfa04796fae4cd7fb0e2
MD5 dee4b7a5083367d1545c429da3e9864c
BLAKE2b-256 2015647434cbf13545dc0a8f9674a40cf8b423c3d9228ec04005f626e1b59e5c

See more details on using hashes here.

Provenance

The following attestation bundles were made for pgscatalog_core-1.0.0-py3-none-any.whl:

Publisher: publish.yml on PGScatalog/pygscatalog

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page