Skip to main content

pgscatalog.match

.github/workflows/match-pytest.yml Documentation Status

This Python package contains:

  • CLI applications to match variants from PGS Catalog scoring files against plink variant information files and output files ready for plink2 --score
  • core library classes and functions for matching variants and creating plink scoring files

If you want to write Python code to match genetic variants, 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.match

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-match --help

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

$ nox

Metadata

Release files for pgscatalog.match 0.4.0

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.match 0.4.0
File Size Uploaded
pgscatalog_match-0.4.0.tar.gz 822.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pgscatalog.match 0.4.0
File Interpreter ABI Platform
pgscatalog_match-0.4.0-py3-none-any.whl Python 3 none any Details

Total release size: 868.9 kB

Release files / pgscatalog_match-0.4.0.tar.gz

Download URL pgscatalog_match-0.4.0.tar.gz
Size 822.2 kB
Tags Source
SHA-256 checksum
How to use checksums
eed1a5d52d90002b6e4d4c815454985979238abd42ca34ba8f01364a1becfab3
BLAKE2b-256 checksum
How to use checksums
559a462fc9d4fe80c1a702864b3a11f1c4cb00fb375eae57988d5470d3a031c2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 10, 2025.

Transparency log

Release files / pgscatalog_match-0.4.0-py3-none-any.whl

Download URL pgscatalog_match-0.4.0-py3-none-any.whl
Size 46.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
59232c7defaf2fcc54ecf821c963b02d517d5d4e9bbfe0aa731f2be29d209380
BLAKE2b-256 checksum
How to use checksums
3c6696115fe77219fb5dfbe6061c83ff230767698bc112d2b7632dedc922d5fd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 10, 2025.

Transparency log

Release history Release notifications | RSS feed

This release

0.4.0 This release

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page