validateLocus: Determine if a Locus Name is in the HLAgazetteer

View source: R/locusValidator.R

validateLocusR Documentation

Determine if a Locus Name is in the HLAgazetteer

Description

Checks a vector of HLA locus names against the HLAgazetteer to determine if the locus name is valid for a specific type of alignment.

Usage

validateLocus(loci, source)

Arguments

loci

A character vector of HLA gene names (ex. "DRB1", c("DRB1","DQB1")).

source

A character vector of alignment source types. "AA", "cDNA", and "gDNA" are allowed types.

Value

A logical value. TRUE indicates that all of the names and source types are valid. FALSE indicates that at least one locus name or alignment source type is invalid.

Note

The results of this check should only be considered valid for the version of the HLAgazetteer included in the HLAtools package.

Examples

validateLocus(loci = "DRB1", source = "AA")
validateLocus(loci = c("V"), source = c("cDNA","gDNA"))
validateLocus(loci = c("E","F","G"), source = "gDNA")

HLAtools documentation built on Aug. 8, 2025, 7:02 p.m.