The R Project SVN R

Rev

Rev 76497 | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 76497 Rev 83379
Line 1... Line 1...
1 
% File src/library/tools/man/buildVignettes.Rd
 1 
% File src/library/tools/man/buildVignettes.Rd
2 
% Part of the R package, https://www.R-project.org
 2 
% Part of the R package, https://www.R-project.org
3 
% Copyright 1995-2019 R Core Team
 3 
% Copyright 1995-2022 R Core Team
4 
% Distributed under GPL 2 or later
 4 
% Distributed under GPL 2 or later
5 
 
 5 
 
6 
\name{buildVignettes}
 6 
\name{buildVignettes}
7 
\alias{buildVignettes}
 7 
\alias{buildVignettes}
8 
\alias{pkgVignettes}
 8 
\alias{pkgVignettes}
Line 12... Line 12...
12 
  and \code{\link{texi2pdf}} on all vignettes
 12 
  and \code{\link{texi2pdf}} on all vignettes
13 
  of a package, or list the vignettes.
 13 
  of a package, or list the vignettes.
14 
}
 14 
}
15 
\usage{
 15 
\usage{
16 
buildVignettes(package, dir, lib.loc = NULL, quiet = TRUE,
 16 
buildVignettes(package, dir, lib.loc = NULL, quiet = TRUE,
17 
               clean = TRUE, tangle = FALSE, ser_elibs = NULL)
 17 
               clean = TRUE, tangle = FALSE, skip = NULL,
- 
 
 18 
               ser_elibs = NULL)
18 
 
 19 
 
19 
pkgVignettes(package, dir, subdirs = NULL, lib.loc = NULL,
 20 
pkgVignettes(package, dir, subdirs = NULL, lib.loc = NULL,
20 
	     output = FALSE, source = FALSE, check = FALSE)
 21 
	     output = FALSE, source = FALSE, check = FALSE)
21 
}
 22 
}
22 
\arguments{
 23 
\arguments{
Line 35... Line 36...
35 
    Weave and run \code{\link{texi2pdf}} in quiet mode.}
 36 
    Weave and run \code{\link{texi2pdf}} in quiet mode.}
36 
  \item{clean}{Remove all files generated by the build, even if there
 37 
  \item{clean}{Remove all files generated by the build, even if there
37 
    were copies there before.}
 38 
    were copies there before.}
38 
  \item{tangle}{logical.
 39 
  \item{tangle}{logical.
39 
    Do tangling as well as weaving.}
 40 
    Do tangling as well as weaving.}
- 
 
 41 
  \item{skip}{a character vector of names of vignettes (without file
- 
 
 42 
    extension, matching the \code{names} returned from
- 
 
 43 
    \code{pkgVignettes}) which should be skipped, or \code{TRUE}
- 
 
 44 
    to skip those with unavailable \samp{\VignetteDepends}
- 
 
 45 
    (from \code{\link{vignetteInfo}}).}
40 
  \item{ser_elibs}{For use from \command{R CMD check}.}
 46 
  \item{ser_elibs}{For use from \command{R CMD check}.}
41 
  \item{subdirs}{a character vector of subdirectories of \code{dir} in
 47 
  \item{subdirs}{a character vector of subdirectories of \code{dir} in
42 
    which to look for vignettes.  The first which exists is used.
 48 
    which to look for vignettes.  The first which exists is used.
43 
    Defaults to \code{"doc"} if \code{package} is supplied, otherwise
 49 
    Defaults to \code{"doc"} if \code{package} is supplied, otherwise
44 
    \code{"vignettes"}.}
50 
    \code{"vignettes"}.}