lein: Lein Name Coding

Description Usage Arguments Details Value Caveats References See Also Examples

View source: R/lein.R

Description

The Lein name coding procedure.

Usage

1
lein(word, maxCodeLen = 4)

Arguments

word

string or vector of strings to encode

maxCodeLen

maximum length of the resulting encodings, in characters

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.

Value

the Lein encoded character vector

Caveats

The lein algorithm is only defined for inputs over the standard English alphabet, i.e., "A-Z." For inputs outside this range, the output is undefined.

References

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, rogerroot, soundex, statcan

Examples

1
2
3
lein("William")
lein(c("Peter", "Peady"))
lein("Stevenson", maxCodeLen = 8)

phonics documentation built on Aug. 17, 2018, 1:04 a.m.