docChecker: Collection of functions to spell check a document.

Description Usage Arguments Value Author(s) References See Also

View source: R/doc.S

Description

This is a collection of functions that provide an interface to spell checking an entire document. One first creates a document checker via docChecker. The reset ensures that the checker is ready to start on a new document. process starts the checking of a new document. The function Next is used after the processing is started to get the “next” mis-spelled word.

Usage

1
2
3
4
docChecker(speller = getSpeller(), class = "AspellDocChecker")
reset(checker)
Next(checker)
process(checker, text) 

Arguments

speller

the sp

class

the name of the class that is used to create the document spell checker. This is used to allow constructors for derived classes to use this function and for tose to specify the desired class.

checker

an object of class AspellDocChecker-class that provides the streaming through the text.

text

a character vector giving the text whose words are to be spell-checked.

Value

These functions are more of interest for their side-effects. Next returns a token giving the location in the text of the documentation of the next mis-spelled word.

Author(s)

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

References

http://aspell.sourceforge.net

See Also

aspell


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