Skip to contents

Phonetic Spelling Algorithms

Source: R/phonics.R
phonics.Rd

Apply one or more phonetic encoders to a character vector and return their codes together in a data frame.

Usage 

phonics(word, method, clean = TRUE)

Arguments

word

A character vector to encode.

method

A character vector naming the methods to apply.

clean

If TRUE, warn and return NA for inputs containing characters outside an encoder's supported alphabet. If FALSE, unsupported characters are discarded before encoding.

Value

A data frame whose first column is word, followed by one character column for each recognized method.

Details

Available methods are "caverphone", "caverphone.modified", "cologne", "lein", "metaphone", "nysiis", "nysiis.modified", "onca", "onca.modified", "onca.refined", "onca.modified.refined", "phonex", "rogerroot", "soundex", "soundex.refined", and "statcan". Unknown method names produce a warning and no result column.

References

Howard, J. P., II (2020). "Phonetic Spelling Algorithm Implementations for R." Journal of Statistical Software, 95(8), 1–21. doi:10.18637/jss.v095.i08 .

See also

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

Examples 

phonics(c("Peter", "Peady"), c("soundex", "soundex.refined"))
#>    word soundex soundex.refined
#> 1 Peter    P360          P10609
#> 2 Peady    P300           P1060