Files
SimurgArray/src/simurg/pipeline/pgx_pheno.py
T
kemalandClaude Opus 5.5 aee8caa39e
ci / test (3.12) (push) Failing after 10s
ci / test (3.13) (push) Failing after 11s
PGx: ClinPGx variant-based genes (PGX-008) and --guideline dpwg (PGX-025)
- fetch_sources.sh downloads ClinPGx clinicalVariants (CC BY-SA 4.0); pgx db build adds genotype-only
  variant-based genes (levels 1A-2B, level 3 for the parity list), rsIDs resolved from the manifest's probes:
  70 genes in the DB.
- pgx phenotype --guideline dpwg: CPIC mappings for CPIC genes (as ClinPGx curates DPWG), no phenotype for
  DPWG-only genes (flags dpwg_via_cpic_mapping / dpwg_mapping_not_available). K-029 updated.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Claude-Session: https://claude.ai/code/session_01814GKVzZVL3FuF3DeiZXhv
2026-09-29 17:01:36 +01:00

162 lines
8.1 KiB
Python

"""``simurg pgx phenotype`` (alias ``annotate``) — phenotypes and the per-sample PGx JSON (spec PGX-024 … PGX-028,
CLI-034). Reads the ``pgx star-allele call`` output folder and the PGx DB; can be re-run with another guideline.
"""
from __future__ import annotations
import hashlib
import json
import sqlite3
from dataclasses import dataclass
from pathlib import Path
from typing import Any
from simurg import __version__
from simurg.core.errors import ExitCode, SimurgError
from simurg.core.log import Reporter
from simurg.pgx.phenotype import build_table, gene_phenotype
JSON_SCHEMA = "simurg.pgx/1"
# PGX-025 DPWG gene coverage. ClinPGx curates DPWG guidelines with the CPIC allele-function and phenotype mappings for
# genes CPIC covers [DOC: ClinPGx, "Genotype-phenotype mapping for curation of DPWG guidelines"], so those genes use the
# CPIC tables (flag dpwg_via_cpic_mapping); DPWG-only genes have no public machine-readable mapping here.
DPWG_GENES = ("CYP1A2", "CYP2B6", "CYP2C19", "CYP2C9", "CYP2D6", "CYP3A4", "CYP3A5", "DPYD", "NUDT15", "SLCO1B1",
"TPMT", "UGT1A1", "VKORC1", "F5") # fmt: skip
TSV_SCHEMA = "simurg.pgx_tsv/1"
@dataclass
class PhenoOptions:
calls: Path # folder written by pgx star-allele call
db: Path
out: Path | None = None
guideline: str = "cpic"
force: bool = False
def db_meta(db: Path) -> dict[str, str]:
con = sqlite3.connect(db)
meta = dict(con.execute("SELECT key, value FROM meta").fetchall())
con.close()
return meta
def tsv_header(db: Path, meta: dict[str, str], guideline: str) -> list[str]:
"""PGX-026: ``#`` metadata lines at the top of every PGx TSV."""
sha = meta.get("content_sha256") or hashlib.sha256(db.read_bytes()).hexdigest()
return [f"#simurg_schema={TSV_SCHEMA}", f"#software_version={__version__}", "#genome_build=GRCh38",
f"#pgx_db={db.name};sha256={sha}", f"#allele_sources={meta.get('allele_sources', '')}",
f"#phenotype_sources={meta.get('phenotype_sources', '')}", f"#guideline={guideline}"] # fmt: skip
def write_meta_tsv(path: Path, header: list[str], cols: list[str], rows: list[dict[str, Any]]) -> None:
from simurg.core.atomic import atomic_write_text
def cell(v: Any) -> str:
if v is None:
return ""
if isinstance(v, float):
if v != v:
return ""
txt = f"{v:.4f}".rstrip("0")
return txt + "0" if txt.endswith(".") else txt
return str(v).replace("\t", " ")
lines = header + ["\t".join(cols)] + ["\t".join(cell(r.get(c)) for c in cols) for r in rows]
atomic_write_text(path, "\n".join(lines) + "\n")
def run_phenotype(o: PhenoOptions, rep: Reporter) -> int:
"""``simurg pgx phenotype`` (CLI-034)."""
from simurg.core.atomic import atomic_write_text
if o.guideline not in ("cpic", "dpwg"):
raise SimurgError("E_PGX_GUIDELINE", f"unknown guideline {o.guideline!r}", hint="cpic or dpwg")
src = o.calls / "pgx_calls.json"
if not src.exists():
raise SimurgError("E_NO_INPUT", f"{src} not found", hint="run pgx star-allele call first")
out = o.out or o.calls
out.mkdir(parents=True, exist_ok=True)
calls = json.loads(src.read_text())
meta = db_meta(o.db)
con = sqlite3.connect(o.db)
tables = {}
for (gene,) in con.execute("SELECT DISTINCT gene FROM phenotypes WHERE guideline = 'cpic'"):
if o.guideline == "dpwg" and gene not in DPWG_GENES:
continue
rows = con.execute("SELECT lookup_key, activity_score, phenotype FROM phenotypes WHERE gene = ? AND "
"guideline = 'cpic'", (gene,)).fetchall() # fmt: skip
alle = con.execute("SELECT allele, function, activity FROM alleles WHERE gene = ?", (gene,)).fetchall()
tables[gene] = build_table(gene, rows, alle)
tested = {g: [a for (a,) in con.execute("SELECT allele FROM alleles WHERE gene = ? AND defined = 1", (g,))]
for (g,) in con.execute("SELECT gene FROM genes")} # fmt: skip
con.close()
sha = meta.get("content_sha256", "")
ann_rows = []
for s in calls["samples"]:
genes = []
for g in s["genes"]:
t = tables.get(g["gene"])
feas = [tuple(x.split("/")) for x in g["feasible_solutions"]]
per: list[str] = []
if t is None:
res = None
else:
res, per = gene_phenotype(t, feas)
if g.get("call_type") == "tagging_variant": # PGX-007: the CPIC result is the tag status itself
from simurg.pgx.phenotype import PhenotypeResult
res, per = PhenotypeResult(g["genotype"], None), []
elif g.get("call_type") == "copy_number":
res, per = None, []
flags = list(g.get("flags", [])) + (res.flags if res else [])
if o.guideline == "dpwg" and g["gene"] in DPWG_GENES:
flags.append("dpwg_via_cpic_mapping" if t is not None else "dpwg_mapping_not_available")
top = g["candidates"][0] if g["candidates"] else {}
top_alleles = top.get("alleles", [])
entry = {"gene": g["gene"], "call_type": g.get("call_type", "star_allele"), "genotype": g["genotype"],
"feasible_solutions": g["feasible_solutions"],
"activity_score": res.activity_score if res else None,
"phenotype": res.phenotype if res else None, "per_solution_phenotypes": per,
"score": top.get("score"), "raw_score": top.get("raw_score"),
"flags": sorted(set(flags)), "copy_number": g.get("copy_number"),
"array_equivalent_alleles": [{"allele": a["allele"], "equivalents": a["array_equivalent_alleles"]}
for a in top_alleles],
"supporting_variants": [v for a in top_alleles for v in a["supporting_variants"]],
"variant_no_calls": g.get("variant_no_calls", []),
"variants_not_covered": g.get("variants_not_covered", []),
"unexplained_variants": g.get("unexplained_variants", []),
"candidate_solutions": [{"rank": i + 1, **c, "phenotype": _pheno_of(tables.get(g["gene"]), c)}
for i, c in enumerate(g["candidates"])],
"alleles_tested": g.get("alleles_tested")
or sorted(tested.get(g["gene"], []), key=_natural)} # fmt: skip
genes.append(entry)
ann_rows.append({"sample_id": s["sample_id"], "sample_name": s.get("sample_name", s["sample_id"]),
"gene": g["gene"], "guideline": o.guideline, "genotype": g["genotype"],
"activity_score": entry["activity_score"], "phenotype": entry["phenotype"],
"flags": ";".join(entry["flags"])}) # fmt: skip
doc = {"schema": JSON_SCHEMA, "software_version": __version__, "genome_build": "GRCh38",
"pgx_db": {"file": o.db.name, "sha256": sha},
"allele_sources": json.loads(meta.get("allele_sources", "[]")),
"phenotype_sources": json.loads(meta.get("phenotype_sources", "[]")), "guideline": o.guideline,
"sample_id": s["sample_id"], "sample_name": s.get("sample_name", s["sample_id"]),
"genes": genes} # fmt: skip
atomic_write_text(out / f"{s['sample_id']}.pgx.json", json.dumps(doc, indent=1, ensure_ascii=False))
cols = ["sample_id", "sample_name", "gene", "guideline", "genotype", "activity_score", "phenotype", "flags"]
ann_rows.sort(key=lambda r: (r["sample_id"], r["gene"]))
write_meta_tsv(out / "diplotype_annotations.tsv", tsv_header(o.db, meta, o.guideline), cols, ann_rows)
rep.info(f"phenotypes ({o.guideline}): {len(calls['samples'])} sample(s) -> {out}")
return ExitCode.OK
def _pheno_of(t: Any, cand: dict[str, Any]) -> str | None:
from simurg.pgx.phenotype import phenotype
return phenotype(t, tuple(cand["genotype"].split("/"))).phenotype if t is not None else None
def _natural(a: str) -> tuple[Any, ...]:
import re
return tuple(int(x) if x.isdigit() else x for x in re.split(r"(\d+)", a))