aspell {utils}R Documentation

Aspell Interface

Description

Spell check given files via Aspell.

Usage

aspell(files, filter, control = list(), encoding = "unknown")

Arguments

files a character vector with the names of files to be checked.
filter an optional filter for processing the files before spell checking, given as either a function (with formals ifile and encoding), or a character string specifying a built-in filter, or a list with the name of a built-in filter and additional arguments to be passed to it. See Details for available filters. If missing or NULL, no filtering is performed.
control a list or character vector of control options for Aspell.
encoding the encoding of the files. Recycled as needed.

Details

It is assumed that the Aspell executable aspell is available in the system search path. See http://aspell.net for information on obtaining Aspell, and available dictionaries.

Currently the only available built-in filters are "Rd", corresponding to RdTextFilter, and "Sweave", corresponding to SweaveTeXFilter.

The print method has for the objects returned by aspell has an indent argument controlling the indentation of the positions of possibly mis-spelled words. The default is 2; Emacs users may find it useful to use an indentation of 0 and visit output in grep-mode.

Value

A data frame inheriting from aspell (which has a useful print method) with the information about possibly mis-spelled words.

See Also

Package Aspell on Omegahat (http://www.omegahat.org/Aspell) for a fine-grained R interface to the Aspell library.

Examples

## Not run: 
# To check all Rd files in a directory, skipping the \references sections
files <- Sys.glob("*.Rd")
aspell(files, filter=list("Rd", drop="\references"))

# To check all Sweave files 
files <- Sys.glob(c("*.Rnw", "*.Snw", "*.rnw", "*.snw"))
aspell(files, filter="Sweave", control="--mode=tex")

# To check all Texinfo files
files <- Sys.glob("*.texi")
aspell(files, control="--mode=texinfo")


## End(Not run)

[Package utils version 2.11.0 Index]