getWordList {Aspell}R Documentation

Retrieve the collections of words stored by the speller.

Description

The speller maintains 3 different collections of words that it uses when performing spell checks and making suggestions for mis-spelled words. These three word lists are termed personal, session and main. This function allows one to access any of these for the given speller.

Usage

getWordList(speller = getSpeller(), which = names(WordListEnum))

Arguments

speller the speller whose lists of words are to be queried.
which the name of the word list to be retrieved. Users should specify the entry by name rather than integer value for clarity in their code. See Aspell:::WordListEnum

Value

If one word list is requested, this returns a character vector. If more than one word list is requested, a named list is returned giving the character vectors for each requested word list. If the list is not accessible, we returned NULL.

Author(s)

Duncan Temple Lang <duncan@wald.ucdavis.edu>

References

http://aspell.sourceforge.net

See Also

getSpeller addToList saveWordLists

Examples
[Package Aspell version 0.2-0 Index]