allele_function.csv¶
One row is one allele-unit — the canonical star-string is the identity and the required key.
Everything beside it is a parsed convenience of the cis unit: copy_number, sv_type,
hybrid_orientation. When a convenience column and the star-string disagree, the star-string is
truth; the others exist so a consumer need not re-parse it.
suballele is optional extra precision (Aldy's Minor, e.g. 1.001) and never replaces the core
star. A consumer keyed on the suballele silently misses every row that carries only the core.
Identity¶
| Row model | AlleleFunctionRow (just_dna_format.pgx) |
| Becomes | allele_function.parquet — lead parquet: allele_function.parquet |
| Authored or derived | authored — a person writes it (a drafter may append rows) |
| Draftable | yes — draft can append rows |
| Drafted by | cpic (pgx_draft, projection, matched on gene, allele) |
| Natural key | gene, allele |
| Fact signature | no |
| In the attestation binding | yes — manifest.inputs[] |
Columns¶
| Column | Type | Required | Values | Meaning |
|---|---|---|---|---|
gene |
str |
required | Gene symbol, e.g. CYP2D6 | |
allele |
str |
required | Star-allele string, verbatim canonical identity, e.g. *4 | |
activity_value |
float | None |
optional | Per-allele activity value (e.g. 1=1.0, 10=0.25, *4=0) | |
function_status |
str | None |
optional | one of: decreased_function, increased_function, no_function, normal_function, uncertain_function, unknown_function |
CPIC function category (VALID_FUNCTION_STATUS) |
suballele |
str | None |
optional | Optional finer sub-allele, e.g. 1.001 (core star is the key) | |
copy_number |
int | None |
optional | Optional cis copy number of the allele-unit (e.g. *1x2 → 2) | |
sv_type |
str | None |
optional | Optional parsed SV type (duplication/deletion/hybrid) | |
hybrid_orientation |
str | None |
optional | Optional parsed tandem/hybrid orientation, e.g. 36+10 |
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.