Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
32 lines (28 sloc) 1.143 kB
% Generated by roxygen2 (4.1.1): do not edit by hand
% Please edit documentation in R/vignettes.r
\name{build_vignettes}
\alias{build_vignettes}
\title{Build package vignettes.}
\usage{
build_vignettes(pkg = ".", dependencies = "VignetteBuilder")
}
\arguments{
\item{pkg}{package description, can be path or package name. See
\code{\link{as.package}} for more information}
\item{dependencies}{\code{logical} indicating to also install uninstalled
packages which this \code{pkg} depends on/links to/suggests. See
argument \code{dependencies} of \code{\link{install.packages}}.}
}
\description{
Builds package vignettes using the same algorithm that \code{R CMD build}
does. This means including non-Sweave vignettes, using make files (if
present), and copying over extra files. You need to ensure that these
files are not included in the built package - ideally they should not
be checked into source, or at least excluded with \code{.Rbuildignore}
}
\seealso{
\code{\link{clean_vignettes}} to remove the pdfs in
\file{inst/doc} created from vignettes
\code{\link{clean_vignettes}} to remove build tex/pdf files.
}
\keyword{programming}
Jump to Line
Something went wrong with that request. Please try again.