Create ID aliases of a specified length

ID aliases are pseudorandom sequences of alphanumeric upper case characters where the letter "O" is not included for readability.. User has the option of providing a character vector of aliases to avoid using. Because aliases are alphanumeric, they never contain a period ("."), honoring the ID rule enforced at data input by qcStudbook.

Usage

obfuscateId(id, size = 10L, existingIds = character(0L), placeholder = NULL)

Arguments

id

character vector of IDs to be obfuscated (alias creation).

size

character length of each alias. An ID that is a placeholder for an unknown parent (see removeAutoGenIds) gets an alias of the same shape, the placeholder prefix plus random characters; when size is too short for that shape to be recognized (shorter than 5 for the default "U%04d" format), only those aliases are made longer, to the shortest recognizable length.

existingIds

character vector of existing aliases to avoid duplication.

placeholder

optional logical vector, one value per id, saying which ids are placeholders for unknown parents (TRUE) and which are real animals (FALSE), as recorded in the placeholder column that qcStudbook writes. A placeholder gets a placeholder-shaped alias and a real animal a real-shaped one, even when the id's own shape says otherwise (a real animal named "U1234"). NA or NULL (the default) reads the id by its shape.

Value

A named character vector of aliases where the name is the original ID value.

See also

Other obfuscation: mapIdsToObfuscated(), obfuscateDate(), obfuscateGenomicROH(), obfuscateGenotypeMatrix(), obfuscateLdBlocks(), obfuscateMhcHaplotypes(), obfuscatePed(), obfuscateTwinRelations()

Examples

library(nprcgenekeepr)
integerIds <- 1L:10L
obfuscateId(integerIds, size = 4L)
#>      1      2      3      4      5      6      7      8      9     10 
#> "D5WU" "LQSG" "TCJH" "J6Q2" "5PCL" "0LX4" "4NN6" "X0W6" "KG6S" "5G10" 
characterIds <- paste0(paste0(sample(LETTERS, 1L, replace = FALSE)), 1L:10L)
obfuscateId(characterIds, size = 4L)
#>     Y1     Y2     Y3     Y4     Y5     Y6     Y7     Y8     Y9    Y10 
#> "UZND" "7JVD" "4L2J" "HTJG" "TUEI" "08D1" "83KX" "88LJ" "FLS7" "SJBP"