multiTranslateGLstring: Translate a Vector of GL Strings to a Desired IPD-IMGT/HLA...

View source: R/GLupdater.R

multiTranslateGLstringR Documentation

Translate a Vector of GL Strings to a Desired IPD-IMGT/HLA Database Version

Description

Translates a column from a data frame in GL String Code format to a desired reference database version.

Usage

multiTranslateGLstring(GLstrings, from, to, expand = FALSE, verbose = FALSE)

Arguments

GLstrings

A vector of GL Strings encoded in the same IPD-IMGT/HLA Database release version.

from

A character string identifying the IPD-IMGT/HLA Database release version of 'GLstrings'.

to

A character string identifying the IPD-IMGT/HLA Database release version to translate 'GLstrings' 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 'GLstrings' 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 trnslation process should be sent to the console (TRUE) or not (FALSE). The default value is FALSE.

Value

A version GLSCs (in a data frame) updated to the desired version. NA values are returned in place of alleles that are not present in 'to'.

References

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

Examples

multiGLs <- multiTranslateGLstring(GLstring.ex$Gl.String[1:50],"3.01.0","2.15.0")
multiGLs <- multiTranslateGLstring(GLstring.ex$Gl.String[1:50],"3.30.0","3.58.0")


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