Skip to content

resolution.csv

Identity

Row model ResolutionRow (just_dna_format.resolution)
Becomes no parquet — see the prose above for where its content goes
Authored or derived derived — an enricher pass writes it; an author corrects it via overrides.csv
Draftable no
Written and checked by just-dna-enricher enrich (enrich) from ensembl, clinvar, gnomad, checking reference_allele, rsid_currency, clinical_significance, rsid_coordinate_agreement, placement_agreement, genome_build_agreement, dataset_currency, published_refutation, evidence_status_currency
Natural key variant_key
Fact signature no
In the attestation binding no

Columns

Column Type Required Values Meaning
variant_key str required Frozen authored identity this row resolves (rsid, else chrom:start:ref)
rsid str | None optional Resolved dbSNP identifier
chrom str | None optional Chromosome without 'chr' prefix
start int | None optional 1-based genomic position (VCF POS convention; matches the Ensembl and ClinVar snapshots)
ref str | None optional Reference allele
alts str | None optional Alt allele(s), comma-separated
genome_build str defaulted Assembly the coordinate is in (the RM15 forward hook; GRCh38 today)
locus_index int defaulted 0 for a 1:1 resolution; 0..N-1 for a one-to-many rsid expansion
vrs_id str | None optional GA4GH VRS allele id (ga4gh:VA.…) — one per ALT, comma-joined and positionally aligned with alts, so a single-alt row carries a bare id and a multi-allelic one names each of its alleles in the same order. An empty member is a hole: that allele's id could not be minted (an indel in an offline run, an off-assembly contig). Minted locally by vrs.derive_vrs_allele_id for a substitution, by the enricher's normalization path for an indel, and cross-checked against a source's own id (gnomAD serves one) where available.
vrs_spec str | None optional VRS spec version the row's vrs_id was minted under, at the spec's minor ('2.0'). The id rule can change at a minor (VRS 2.1 re-ids some ambiguous insertions), so this is what tells an id minted under another rule from a corrupt one: a stated version that differs from the module's pin (manifest.compilation.vrs_version) is reported as vrs_version_differs; a substitution that recomputes differently under another VRS major is counted there, never as a mismatch. Written only by the run that minted the id; empty means unstated, never the current version (RM304).
caid str | None optional ClinGen Allele Registry canonical allele id (CA<digits>)
source str | None optional Which link filled this: cache|ensembl-graphql|ensembl-rest|manual|reversed (open)
authority str | None optional The licensed data source the link speaks for — ensembl for ensembl-rest/ensembl-graphql/cache, clinvar for the snapshot, gnomad for the last-resort link. Joins sources.csv.source. Empty when there is no external authority to declare (authored, manual: the module's own bytes or a human). A reversed row keeps the authority of the row it was reversed from, since its facts are still that source's (RM380).
status str | None optional one of: ambiguous, not_found, resolved Resolution outcome: resolved|not_found|ambiguous
rsid_alternates str | None optional When a reverse (position→rsid) back-fill hit several candidate rsIDs for the same exact allele (a genuine dbSNP merge), the full sorted candidate list (comma-separated); rsid carries the deterministic pick (lowest id) and status is 'ambiguous'. Empty otherwise. Provenance — EXCLUDED from resolution_signature (0.5, provisional).
rsid_current str | None optional The rsID dbSNP serves today when the authored one has been merged away (e.g. rs3051860 for an authored rs3216883). Recorded, never substituted — weights.parquet carries the rsID as identity, so writing the new label into the artifact would migrate variant_key by network lookup and break the round-trip fixed point (Principle 7).
rsid_status str | None optional one of: absent, live, merged, withdrawn What dbSNP currently says about rsid: live|merged|absent|withdrawn. The automated check never emits withdrawn — a retracted rsID is byte-identical to a never-assigned one through every live endpoint — so it reports absent and names both readings. withdrawn is for a curator who has established the retraction by hand, and it refuses in BOTH modes where absent refuses only under strict, because a retracted variant may invalidate the annotation rather than merely dating it. Provenance — EXCLUDED from resolution_signature (time-varying external state).
placement_witness str | None optional Which second authority was asked where this row's placement sits: clinvar, clinvar_gkm, and, on an online run, ensembl (Ensembl REST, asked about an indel the Ensembl snapshot placed and neither of the others holds), +-joined in sorted order. ensembl is the snapshot's own authority, so its answer is self-consistent, never independent. Empty means nobody was asked (none was loaded, the row's own link is ClinVar's, or REST could not be reached). A placement a witness contradicts is never written (RM267).
placement_verdict str | None optional one of: same_event, undecided, unplaced What placement_witness answered: same_event|undecided|unplaced. undecided is a respelling nothing this run held could settle; unplaced means the witness holds no placement of this allele, so the row has one witness only. Empty when nobody was asked.
left_aligned bool | None optional Whether the enricher checked this row's spelling to be the leftmost parsimonious one, ALT by ALT, against the reference: true checked left-aligned, false checked and not, empty unknown (no reference read, a non-nucleotide allele, or a row written before 0.8). A coordinate the enricher fills from an rsID is written left-aligned; a coordinate a module authored is recorded as authored and only judged here (RM270). A caller's left-aligned VCF joins a false row's indel only through vrs_id.
authored_event str | None optional one of: different_event, same_event, undecided Whether the coordinate the module authored for this subject spells the same event as this row's locus, judged by the enricher against the reference: same_event|different_event|undecided. Written only where the two spellings differ (an indel anchored elsewhere in its repeat, a coordinate from another release's spelling). The compiler reads same_event as agreement and fills only the cells no spelling changes; undecided is no verdict, never agreement. Empty when the spellings are identical, the subject authored no coordinate, or the row predates 0.8 (RM375).
judged_coordinate str | None optional The authored coordinate authored_event judged, as authored_coordinate_key spells it (chrom:start[:ref], the contig empty for a half coordinate). The compiler trusts the verdict only for a row whose authored coordinate is still this one: an edit made after the enricher judged, or another table's row under the same key, reads as never judged (RM375).
fetched_at str | None optional ISO-8601 UTC timestamp, second resolution (e.g. '2026-08-03T02:03:23Z'). Canonicalized on load; records when this row was last written by a pass, not when the source published anything
source_release str | None optional The release of the snapshot or service that answered this row, as it states its release: an Ensembl snapshot's manifest.json release_id (ensembl-variation-2026_07_13-vep116.0) or release.json dataset, a ClinVar snapshot's clinvar_<date>, live Ensembl REST's data release (ensembl_116, from /info/data), gnomAD's dataset id. Written only by the run that answered the row, and never back-filled onto a row it did not answer. Empty means not recorded (a source that states no release, a row written before 0.8, an authored row), never the current release. A reversed row keeps the release of the row it was reversed from (RM380).
source_loci str | None optional Every place the links answered this rsID at in the run that wrote the row, as chrom:start comma-joined and sorted (5:500,6:600), before the authored genotype chose among them: the hosting filter, a disputed placement (RM267) and the pseudoautosomal choice narrow what the rows place. Written on the rows under the rsID's own key, and only where the set holds a place they stand for nowhere (a respelled piece stands for its source locus, a Y pseudoautosomal twin for its X partner). Empty means the rows place the whole answer, or the row predates the column (RM387); either way the compiler reads the rows as the whole answer.

Generated from the row model at build time — reference.authoring_reference(), the same answer describe_table gives an authoring tool. Nothing on this page is hand-kept.