The R Project SVN R

\name{aspell}
\alias{aspell}
\title{Aspell Interface}
\description{
  Spell check given files via Aspell.
}
\usage{
aspell(files, filter, control = list(), encoding = "unknown")
}
\arguments{
  \item{files}{a character vector with the names of files to be checked.}
  \item{filter}{an optional filter for processing the files before spell
    checking, given as either a function (with formals \code{ifile} and
    \code{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 \bold{Details} for available
    filters.  If missing or \code{NULL}, no filtering is performed.}
  \item{control}{a list or character vector of control options for
    Aspell.}
  \item{encoding}{the encoding of the files.  Recycled as needed.}
}
\details{
  It is assumed that the Aspell executable \code{aspell} is available in
  the system search path.  See \url{http://aspell.net} for information
  on obtaining Aspell, and available dictionaries.
  
  Currently the only available built-in filters are \code{"Rd"},
  corresponding to \code{\link{RdTextFilter}}, and \code{"Sweave"},
  corresponding to \code{\link{SweaveTeXFilter}}.

  The print method has for the objects returned by \code{aspell} has an
  \code{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 \code{aspell} (which has a useful print
  method) with the information about possibly mis-spelled words.
}
\seealso{
  Package \pkg{Aspell} on Omegahat
  (\url{http://www.omegahat.org/Aspell}) for a fine-grained R interface
  to the Aspell library.
}
\examples{
\dontrun{
# 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")

}
}
\keyword{utilities}