Skip to main content

abotyper-core

A Python package to assign ABO genotypes and alleles from variant calls using the ISBT database panel.

The ABO blood group typing logic from nf-core/abotyper, packaged as a Python library and a set of command-line tools.

It loads and validates the ABO variant panel, turns Clair3 calls and BAM pileups into per-position evidence, resolves phenotype, genotype and ISBT allele names, and writes the per-sample and aggregated result tables.

Research use only. Not validated for clinical diagnosis or transfusion decisions.

Install

pip install abotyper-core                     # PyPI
conda install -c conda-forge -c bioconda abotyper-core   # Bioconda

Containers: quay.io/biocontainers/abotyper-core (BioContainers, built from the Bioconda package).

Python 3.11 or newer. Dependencies: pandas, numpy, pyyaml, xlsxwriter and openpyxl.

Commands

Command What it does
abotyper-panel Validate and summarise a variant panel; --check-isbt compares it with the ISBT allele table
abotyper-panel-to-bed BED of panel positions for Clair3 --bed_fn and bcftools view -R
abotyper-clair2metrics Per-position metrics from Clair3 VCFs
abotyper-clair2haplotypes Phased haplotypes from Clair3 VCFs
abotyper-pileup2metrics Per-position metrics from BAM pileups
abotyper-predict-phenotype Phenotype, genotype and ISBT allele calls per sample
abotyper-aggregate Aggregate per-sample results into the final report (xlsx, csv)
abotyper-calibrate-panel Fill amplicon coordinates into a panel from a reference
abotyper-rename-samples Rename samples from a mapping sheet

Each command takes --help. Commands that read the panel default to the bundled abotyper_core/data/abo_variant_panel.yaml; pass --panel to use another one.

Checking the panel against ISBT

abotyper-panel --check-isbt                          # fetch the live ISBT ABO allele table
abotyper-panel --isbt-source ABO_allele_table.xlsx   # or the file the site's EXPORT button downloads

The check reads the ABO alleles from the ISBT blood group allele database and compares them with the panel and its coverage table (abo_isbt_v9_coverage.tsv, which records how the panel handles every ISBT DNA change). It lists suggestions; it never edits the panel:

Kind Meaning
new_change a DNA change in a current allele that neither the panel nor the coverage table knows (exon 1 changes are flagged as assay gaps)
new_allele an allele not in the baseline snapshot, and whether its changes are already handled
changed_allele an allele whose changes or phenotype differ from the baseline
retired_allele a baseline allele that is gone or marked obsolete
panel_change_not_in_isbt a panel row whose change no current allele carries
release the ISBT release differs from the one the panel was last checked against

Alleles are compared with a baseline snapshot, by default the bundled isbt_abo_alleles.tsv (ISBT release 21, 2026-11-01). After reviewing and updating the panel, save a new baseline with --isbt-snapshot. Use --isbt-report to write the suggestions as a TSV and --fail-on-changes (exit status 3) in scheduled jobs; the repository's monthly ISBT check workflow opens an issue when there is something to review.

The ISBT site has no documented allele API: the check reads the allele records the ABO page embeds, and fails with a clear message if the page layout changes. --isbt-source with an export file always works.

Legacy names

The package also installs the script names the pipeline's modules call today (abo_panel.py, panel_to_bed.py, clair2metrics.py, clair2haplotypes.py, pileup2metrics.py, predict_abo_phenotype.py, aggregate_abo_reports.py), so the pipeline can switch from its bin/ scripts to this package without changing module scripts.

Library use

from abotyper_core import load_panel, default_panel_path

panel = load_panel(default_panel_path())
for marker in panel.calibrated():
    print(marker.id, marker.resolved_position())

Development

pip install -e ".[test]"
ruff check src tests
pytest

The golden tests run every step on ten fixture samples and compare the outputs byte for byte (xlsx cell by cell) with tests/golden/. After an intended output change, regenerate them with UPDATE_GOLDEN=1 pytest and review the diff. tests/requirements-pinned.txt lists the versions the golden files were made with.

Citation

If you use this package, please cite nf-core/abotyper and its publication: PubMed 40564908.

Licence

MIT. See LICENSE.

Metadata

Release files for abotyper-core 0.1.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 abotyper-core 0.1.0
File Size Uploaded Provenance Actions
abotyper_core-0.1.0.tar.gz 440.9 kB With provenance Details for abotyper_core-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for abotyper-core 0.1.0
File Interpreter ABI Platform Actions
abotyper_core-0.1.0-py3-none-any.whl Python 3 none any Details for abotyper_core-0.1.0-py3-none-any.whl

Total release size: 572.7 kB

Release files / abotyper_core-0.1.0.tar.gz

Download URL abotyper_core-0.1.0.tar.gz
Size 440.9 kB
Tags Source
SHA-256 checksum
How to use checksums
98f14191cbd4133d59100945c4d4e6147287a8b9b0b5f549d09cf676cc5b97ea
BLAKE2b-256 checksum
How to use checksums
8cb60a8e20ce668a3f826756fac5890890b43a3fbb4623256673b68fd685909d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 Nov 12, 2026.

Transparency log

Release files / abotyper_core-0.1.0-py3-none-any.whl

Download URL abotyper_core-0.1.0-py3-none-any.whl
Size 131.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2f7fbdfcc0ea2a64e4a52fc31cdb5c406a83df727be7446b556c63796d55b6ab
BLAKE2b-256 checksum
How to use checksums
e478a9e43274ed2e7dfe55dacb90fdeaee139d61c4241997622c28c17000b1af
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 Nov 12, 2026.

Transparency log

Security for abotyper-core 0.1.0

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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for abotyper_core-0.1.0.tar.gz

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 Nov 12, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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