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.2.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.2-py3-none-any.whl (50.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pgscatalog_core-1.0.2.tar.gz
Algorithm Hash digest
SHA256 657a468187ba084c623ef3d73f0e03ce38af7bdd1422568d789ec81c2929f793
MD5 620b46966d25023d799293388ed7d2c1
BLAKE2b-256 a5d43d37e1ea3e133369d28db055a4c7536fefe4e70d34576871533771f13e1b

See more details on using hashes here.

Provenance

The following attestation bundles were made for pgscatalog_core-1.0.2.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.2-py3-none-any.whl.

File metadata

File hashes

Hashes for pgscatalog_core-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1733731d5c8dbf4e43188e0f27abeff4880b591c7ea00aea63b571e8fa46d0de
MD5 d8bdb16685abb90ea02b5a1e0b2f4155
BLAKE2b-256 2dfb53b77996a67a79a7dbf683db2c8cdec5d113ed5f1aa6528ed1b42addaea7

See more details on using hashes here.

Provenance

The following attestation bundles were made for pgscatalog_core-1.0.2-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