nysiis: New York State Identification and Intelligence System

Description Usage Arguments Details Value Caveats References See Also Examples

View source: R/nysiis.R

Description

The NYSIIS phonetic algorithm

Usage

1
nysiis(word, maxCodeLen = 6, modified = FALSE)

Arguments

word

string or vector of strings to encode

maxCodeLen

maximum length of the resulting encodings, in characters

modified

if TRUE, use the modified NYSIIS algorithm

Details

The nysiis function phentically encodes the given string using the New York State Identification and Intelligence System (NYSIIS) algorithm. The algorithm is based on the implementation provided by Wikipedia and is implemented in pure R using regular expressions.

The variable maxCodeLen is the limit on how long the returned NYSIIS code should be. The default is 6.

The variable modified directs nysiis to use the modified method instead of the original.

Value

the NYSIIS encoded character vector

Caveats

The nysiis 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

Robert L. Taft, Name search techniques, Bureau of Systems Development, Albany, New York, 1970.

See Also

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

Examples

1
2
3
4
nysiis("Robert")
nysiis("rupert")
nysiis(c("Alabama", "Alaska"), modified = TRUE)
nysiis("mississippi", 4)

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