phonics (version 1.3.10)

lein: Lein Name Coding

Description

The Lein name coding procedure.

Usage

lein(word, maxCodeLen = 4, clean = TRUE)

Arguments

word

string or vector of strings to encode

maxCodeLen

maximum length of the resulting encodings, in characters

clean

if TRUE, return NA for unknown alphabetical characters

Value

the Lein encoded character vector

Details

The variable word is the name to be encoded. The variable maxCodeLen is the limit on how long the returned name code should be. The default is 4.

The lein algorithm is only defined for inputs over the standard English alphabet, i.e., "A-Z.". Non-alphabetical characters are removed from the string in a locale-dependent fashion. This strips spaces, hyphens, and numbers. Other letters, such as "<U+00DC>," may be permissible in the current locale but are unknown to lein. For inputs outside of its known range, the output is undefined and NA is returned and a warning this thrown. If clean is FALSE, lein attempts to process the strings. The default is TRUE.

References

James P. Howard, II, "Phonetic Spelling Algorithm Implementations for R," Journal of Statistical Software, vol. 25, no. 8, (2020), p. 1--21, <10.18637/jss.v095.i08>.

Billy T. Lynch and William L. Arends. "Selection of surname coding procedure for the SRS record linkage system." United States Department of Agriculture, Sample Survey Research Branch, Research Division, Washington, 1977.

See Also

Other phonics: caverphone(), cologne(), metaphone(), mra_encode(), nysiis(), onca(), phonex(), phonics(), rogerroot(), soundex(), statcan()

Examples

# NOT RUN {
lein("William")
lein(c("Peter", "Peady"))
lein("Stevenson", maxCodeLen = 8)

# }