forked from trinker/pacman
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathp_vignette.Rd
47 lines (43 loc) · 1.31 KB
/
p_vignette.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/p_vignette.R
\name{p_vignette}
\alias{p_vignette}
\alias{p_vign}
\title{View Package Vignette(s)}
\usage{
p_vignette(..., char, interactive = TRUE, character.only = FALSE)
p_vign(..., char, interactive = TRUE, character.only = FALSE)
}
\arguments{
\item{char}{Character vector containing packages to find vignettes for. If
you are calling \code{p_vignette} from within a function (or just having
difficulties calling it using a character vector input) then pass your
character vector of packages to this parameter directly.}
\item{interactive}{logical. If \code{TRUE} will generate an HTML list of
selections.}
\item{character.only}{logical. If \code{TRUE} then \code{p_vignette} will
only accept a single input which is a character vector containing the names
of packages to find vignettes for.}
\item{\ldots}{name(s) of package(s).}
}
\description{
Interactively view vignettes for package(s) or return a dataframe of
vignettes and accompanying information.
}
\examples{
\dontrun{
p_vignette(interactive = FALSE)
p_vignette()
p_vign()
p_vign(pacman)
p_vign(grid, utils)
p_vign(grid, utils, interactive = FALSE)
p_vign(fortunes)
}
}
\seealso{
\code{\link[utils]{vignette}},
\code{\link[utils]{browseVignettes}}
}
\keyword{package}
\keyword{vignette}