Description
Parse an explicit star-allele copy token; copies is zero when the copy number is unknown.
Pharmacogenomic records distinguish allele labels, copy counts, reference-sequence versions, coordinate systems, and evidence about chromosome phase. A balanced count or matching token can check a record without establishing the underlying genotype. Supplied activity values and interpretation rules remain separate from a current gene-specific clinical guideline.
Parse an explicit star-allele copy token; copies is zero when the copy number is unknown.
When to use this tool
Use Pharmacogene Copy Number Token Field when you need this specific allele-token, reference-coordinate, copy-budget, or source-support check.
How to use the tool and how it works
- Enter token. Use the units and conventions below.
- Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
- Read allele, copies, known. Inspect known before interpreting the associated values.
Accept a major star allele followed by x or the multiplication sign and a positive copy count or uppercase N. Return allele, copies, and known; N yields copies=0 and known=false.1
| Input field | Meaning and units | Accepted input |
|---|---|---|
| token | Complete literal token in the grammar stated above. | Required. Text; maximum UTF-16 length 8192. |
| Output field | Interpretation | Returned shape |
|---|---|---|
| allele | Allele | Required. Text; maximum UTF-16 length 8192. |
| copies | Positive copy count when known=true; zero placeholder for N. | Required. Safe integer. |
| known | False exactly for the unknown-copy N marker. | Required. Boolean. |
{
"input": {
"token": "*2×3"
},
"output": {
"allele": "*2",
"copies": 3,
"known": true
}
}Limitations and assumptions
- Suballele suffixes and surrounding whitespace are unsupported. The unknown zero is a placeholder, not zero copies; the token is not checked against a gene or interpreted clinically.
- Inputs must satisfy both the field types and the cross-field conditions above. Invalid input causes an error; a successful false flag or documented placeholder is a different result.
Alternative or Complementary methods
Use a current gene-specific nomenclature and a validated interpretation process when allele identity, phase, function, or clinical decisions matter. Verify source versions and reference coordinates before combining records.
References
Similar or alternative tools
- Star Allele Copy Budget Remainder
Audit caller-supplied allele labels and copy counts without allele calling, phenotype inference or dosing guidance.
- Pharmacogene Diplotype Copyallocation Budget
For nonnegative integer totalCopies, firstCopies, secondCopies, and unresolvedCopies return allocated=firstCopies+secondCopies, unaccounted=totalCopies-firstCopies-secondCopies-unresolvedCopies, and consistent on exact balance.