DocSpeller: Generator function for spell-checking words in a document.

Description Usage Arguments Value Author(s) References See Also

View source: R/doc.S

Description

These functions a function that returns a CallbackResult for spell-checking words in a document and managing the mis-spellings, etc. This is used by spellDoc. The particular callback function that it returns is an interactive

Usage

1
2
DocSpeller(correct = TRUE, class = "CallbackResult", elClass = "SpellingReplacement")
collectWords(class = "CallbackResult")

Arguments

correct

a logical value. If TRUE this causes the callback function to tell the speller about the word the user selects as the alternative for the mis-spelled word. In this way, the speller can learn for future occurrences of this word. If this is not desirable, use FALSE and there is no feedback to the checker.

class

the name of the class of the returned object. This allows the caller to provide the named of a derived class and still use this constructor function.

elClass

the name of the class to use when creating objects for describing the mis-spelled word, its location and the choice of alternative.

Value

An object of class class which, by default, is CallbackResult-class.

Author(s)

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

References

http://aspell.sourceforge.net http://www.omegahat.org/Aspell

See Also

aspell spellDoc CallbackResult-class


omegahat/Aspell documentation built on May 24, 2019, 1:50 p.m.