\HeaderA{checkVignettes}{Check Package Vignettes}{checkVignettes}
\aliasA{print.checkVignettes}{checkVignettes}{print.checkVignettes}
\keyword{utilities}{checkVignettes}
\keyword{documentation}{checkVignettes}
\begin{Description}\relax
Check all \code{\LinkA{Sweave}{Sweave}} files of a package by running
\code{\LinkA{Sweave}{Sweave}} and/or \code{\LinkA{Stangle}{Stangle}} on them. All
R source code files found after the tangling step are
\code{\LinkA{source}{source}}ed to check whether all code can be
executed without errors.
\end{Description}
\begin{Usage}
\begin{verbatim}
checkVignettes(package, dir, lib.loc = NULL,
               tangle = TRUE, weave = TRUE, latex = FALSE,
               workdir = c("tmp", "src", "cur"),
               keepfiles = FALSE)
\end{verbatim}
\end{Usage}
\begin{Arguments}
\begin{ldescription}
\item[\code{package}] a character string naming an installed package.  If
given, Sweave files are searched in subdirectory \file{doc}.
\item[\code{dir}] a character string specifying the path to a package's root
source directory.  This subdirectory \file{inst/doc} is searched for
Sweave files.
\item[\code{lib.loc}] a character vector of directory names of \R{} libraries,
or \code{NULL}.  The default value of \code{NULL} corresponds to all
libraries currently known.  The specified library trees are used to
search for \code{package}.
\item[\code{tangle}] Perform a tangle and \code{\LinkA{source}{source}} the extracted code?
\item[\code{weave}] Perform a weave?
\item[\code{latex}] logical: if \code{tangle}, \code{weave} and \code{latex}
are \code{TRUE} and there is no \file{Makefile} in the vignettes
directory, run the tangled files through \code{pdflatex}.
\item[\code{workdir}] Directory used as working directory while checking the
vignettes. If \code{"tmp"} then a temporary directory is created,
this is the default.  If \code{"src"} then the directory containing
the vignettes itself is used, if \code{"cur"} then the current
working directory of \R{} is used.
\item[\code{keepfiles}] Delete file in temporary directory?  This option is
ignored when \code{workdir != "tmp"}.
\end{ldescription}
\end{Arguments}
\begin{Value}
An object of class \code{"checkVignettes"} which is a list with the
error messages found during the tangle and weave steps. There is a
\code{print} method for nicely displaying the information 
contained in such objects.
\end{Value}

