Star Allele Copy Budget Remainder Tool

Description

Audit caller-supplied allele labels and copy counts without allele calling, phenotype inference or dosing guidance.

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.

Audit caller-supplied allele labels and copy counts without allele calling, phenotype inference or dosing guidance.

When to use this tool

Use Star Allele Copy Budget Remainder 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 alleleTokens, copyCounts, suppliedTotalCopies. Keep parallel arrays aligned. Use the units and conventions below.
Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
Read assignedCopies, unassignedCopies, duplicateAlleleTokens. Inspect duplicateAlleleTokens before interpreting the associated values.

Require aligned alleleTokens and nonnegative integer copyCounts and a nonnegative suppliedTotalCopies. Sum assignedCopies, reject totals above suppliedTotalCopies, and return unassignedCopies and duplicateAlleleTokens using exact token equality.^[1]

Input field	Meaning and units	Accepted input
alleleTokens	Allele Tokens	Required. Array of text; maximum UTF-16 length 8192; maximum items 256.
copyCounts	Nonnegative integer copy count for each aligned allele-token row.	Required. Array of safe integer; maximum items 256.
suppliedTotalCopies	Supplied Total Copies	Required. Safe integer; minimum 0.

Output field	Interpretation	Returned shape
assignedCopies	Assigned Copies	Required. Safe integer.
unassignedCopies	Unassigned Copies	Required. Safe integer.
duplicateAlleleTokens	True for repeated exact labels; their counts are still summed.	Required. Boolean.

json

{
  "input": {
    "alleleTokens": [
      "*1",
      "*2"
    ],
    "copyCounts": [
      1,
      1
    ],
    "suppliedTotalCopies": 3
  },
  "output": {
    "assignedCopies": 2,
    "unassignedCopies": 1,
    "duplicateAlleleTokens": false
  }
}

Limitations and assumptions

Tokens are not validated against an allele nomenclature or deduplicated before summation. Copy balance does not establish genotype, chromosome phase, or clinical function.
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.
Numeric calculations use binary floating point unless exact decimal-integer arithmetic is explicitly stated. No hidden measurement tolerance or decimal rounding is added; nonfinite or out-of-contract results are rejected. Signed zero is exported as zero.

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

Calculation and input contract: pharmacogenomics/star-allele-copy-budget-remainder — tool.io

Similar or alternative tools

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.
Pharmacogene Copy Number Token Field
Parse an explicit star-allele copy token; copies is zero when the copy number is unknown.