phonics (version 1.2.3)

soundex: Soundex

Description

The Soundex phonetic algorithms

Usage

soundex(word, maxCodeLen = 4L)
refinedSoundex(word, maxCodeLen = 10L)

Arguments

word

string or vector of strings to encode

maxCodeLen

maximum length of the resulting encodings, in characters

Value

soundex encoded character vector

Caveats

The soundex and refinedSoundex algorithms are only defined for inputs over the standard English alphabet, i.e., "A-Z." For inputs outside this range, the output is undefined.

Details

The function soundex phonentically encodes the given string using the soundex algorithm. The function refinedSoundex uses Apache's refined soundex algorithm. Both implementations are loosely based on the Apache Commons Java editons.

The variable maxCodeLen is the limit on how long the returned soundex should be.

References

Charles P. Bourne and Donald F. Ford, "A study of methods for systematically abbreviating English words and names," Journal of the ACM, vol. 8, no. 4 (1961), p. 538-552.

Howard B. Newcombe, James M. Kennedy, "Record linkage: making maximum use of the discriminating power of identifying information," Communications of the ACM, vol. 5, no. 11 (1962), p. 563-566.

See Also

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

Examples

# NOT RUN {
soundex("wheel")
soundex(c("school", "benji"))

# }