Skip to main content

Libraries and applications for working with calculated polygenic scores

Project description

pgscatalog.calc

Run pytest on pgscatalog.calc Documentation Status

This Python package contains:

  • CLI applications to aggregate and adjust calculated polygenic scores (PGS) in the context of genetic ancestry similarity
  • library classes and functions for working with calculated PGS and PCA data

[!NOTE]

  • This package doesn't contain functionality to calculate a PGS from target genomes and scoring files
  • If you want software that does that, check out the PGS Catalog Calculator
  • This package is focused on PGS aggregation and normalisation, and is used internally by the PGS Catalog Calculator
Application Description Link
pgscatalog-aggregate Aggregate calculated PGS split across multiple files README
pgscatalog-ancestry-adjust Adjust calculated PGS in the context of genetic ancestry README

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

Installation

install with bioconda

or install via pip:

$ pipx install pgscatalog.calc

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-aggregate --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_calc-0.3.1.tar.gz (727.4 kB view details)

Uploaded Source

Built Distribution

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

pgscatalog_calc-0.3.1-py3-none-any.whl (28.3 kB view details)

Uploaded Python 3

File details

Details for the file pgscatalog_calc-0.3.1.tar.gz.

File metadata

  • Download URL: pgscatalog_calc-0.3.1.tar.gz
  • Upload date:
  • Size: 727.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for pgscatalog_calc-0.3.1.tar.gz
Algorithm Hash digest
SHA256 2dea2426c0bdf579662bf5b42fd2b047e662d5bc612bf2a39cb433142ffe5206
MD5 cd865e8a58199093b4914680221ffddc
BLAKE2b-256 5c209b12437469ff1ca51182c5c01c9bcf0ff68e7d01407cccada4e78e19a27c

See more details on using hashes here.

Provenance

The following attestation bundles were made for pgscatalog_calc-0.3.1.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_calc-0.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for pgscatalog_calc-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 95c456a34f8a9e9362ebf8d47ed8e88ccc1735035a54db0ebef57baf216c2b35
MD5 b3d1e3439874a2b651048a9afa67c8ac
BLAKE2b-256 bb882aae0d5689d3b825c5957dd240fe0a327c4ea9ed7a8c905441a2c94a97f1

See more details on using hashes here.

Provenance

The following attestation bundles were made for pgscatalog_calc-0.3.1-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