alleleTrim: Trim All Versions of HLA Allele Names

In HLAtools: Toolkit for HLA Immunogenomics

Trim All Versions of HLA Allele Names

Description

Trims an HLA allele name to a specified number of fields or number of digits, depending on the nomenclature epoch. Expression variant suffixes in full-length allele names can be appended to truncated allele names.

Usage

alleleTrim(allele, resolution, version = 3, append = FALSE)

Arguments

allele	A character string of an HLA allele name formatted as locus*allele_name, optionally including the "HLA-" prefix.
resolution	A number identifying the number of fields to trim the allele name to.
version	A number identifying the HLA nomenclature epoch under which the allele was named. Epoch 1 allele names are found in IPD-IMGT/HLA Database releases 1.0.0 to 1.16.0. Epoch 2 allele names are found in IPD-IMGT/HLA Database releases 2.0.0 to 2.28.0. Epoch 3 allele names are found in IPD_IMGT/HLA Database releases 3.0.0 and onward.
append	A logical. When append = TRUE, the expression variant suffix of a full-length allele name is appended to a truncated allele name. The default value is FALSE.

Value

A character string of the trimmed allele name, shortened according to the input parameters.

Note

Expression variant suffixes will not be removed from full-length allele names that have fewer than four fields or eight digits.

Examples

alleleTrim(allele = "A*03:01:01", resolution = 2)
alleleTrim(allele = "A*030101", resolution = 2,version = 2)
alleleTrim(allele = "A*0303N",resolution = 1,version = 1, append = TRUE)
alleleTrim("HLA-A*24020102L",resolution = 3,version = 2, append = TRUE)

HLAtools documentation built on June 8, 2025, 12:24 p.m.