GLupdate: Update a GL String Code to a Specified IPD-IMGT/HLA Database...

View source: R/GLupdater.R

GLupdateR Documentation

Update a GL String Code to a Specified IPD-IMGT/HLA Database Version

Description

Updates the elements of a GLString Code across IPD-IMGT/HLA Database release versions. Truncated allele names can be expanded to the list of all allele names that contain the truncated name.

Usage

GLupdate(GLSC, to, expand = FALSE, verbose = FALSE)

Arguments

GLSC

A GL String Code containing HLA allele names.

to

A character string identifying the IPD-IMGT/HLA Database release version to translate 'GLSC' to. Values can range from version 1.05.0 to the loaded version of the alleleListHistory object.

expand

A logical that indicates if the lowest-numbered truncated allele names that match truncated allele names in 'GLSC' should be returned (expand = FALSE), or if a slash-delimited string of all matching full-length allele names should be returned (expand = TRUE). The default value is FALSE.

verbose

A logical that indicates if messages regarding the update process should be sent to the console (TRUE) or not (FALSE). The default value is FALSE.

Value

A GL String Code updated to the 'to' release version.

Note

This function is maintained for compatibility with previous releases, and will be removed in a future release. HLAtools users are advised to use updateGL().

References

Mack et al. HLA 2023;102(2):206-212 https://doi.org/10.1111/tan.15126

Mack et al. HLA 2023;102(4):501-507 https://doi.org/10.1111/tan.15145

Examples

GLupdate(GLSC.ex$GL.String.Code[1],"2.15.0",FALSE,FALSE)
GLupdate(GLSC.ex$GL.String.Code[1],"2.15.0",TRUE,FALSE)


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