Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!
Get Started for Free

statcan

Statistics Canada Name Coding

Description

The modified Statistics Canada name coding procedure

Usage

statcan(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

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 statcan algorithm is only defined for inputs over the standard French alphabet. Non-alphabetical characters are removed from the string in a locale-dependent fashion. This strips spaces, hyphens, and numbers. Other letters, such as "Ü," may be permissible in the current locale but are unknown to statcan. For inputs outside of its known range, the output is undefined and NA is returned and a warning this thrown. If clean is FALSE, statcan attempts to process the strings. The default is TRUE.

Value

the Statistics Canada encoded character vector

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(), lein(), metaphone(), mra_encode(), nysiis(), onca(), phonex(), phonics(), rogerroot(), soundex()

Examples

statcan("William")
statcan(c("Peter", "Peady"))
statcan("Stevenson", maxCodeLen = 8)
phonics

Phonetic Spelling Algorithms

v1.3.10
BSD_2_clause + file LICENSE
Authors
James Howard [aut, cre] (<https://orcid.org/0000-0003-4530-1547>), Kyle Haynes [ctb], Amanda Hood [ctb], Os Keyes [ctb]
Initial release
2021-7-11

We don't support your browser anymore

Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.