vignette | R Documentation |
View a specified package vignette, or list the available ones; display it rendered in a viewer, and get or edit its R source file.
vignette(topic, package = NULL, lib.loc = NULL, all = TRUE) ## S3 method for class 'vignette' print(x, ...) ## S3 method for class 'vignette' edit(name, ...)
topic |
a character string giving the (base) name of the vignette to view. If omitted, all vignettes from all installed packages are listed. |
package |
a character vector with the names of packages to
search through, or |
lib.loc |
a character vector of directory names of R libraries,
or |
all |
logical; if |
x, name |
object of class |
... |
ignored by the |
Function vignette
returns an object of the same class, the
print method opens a viewer for it.
On Unix-alikes,
The program specified by the pdfviewer
option is used for
viewing PDF versions of vignettes.
If several vignettes have PDF/HTML versions with base name identical
to topic
, the first one found is used.
If no topics are given, all available vignettes are listed. The
corresponding information is returned in an object of class
"packageIQR"
.
browseVignettes
for an HTML-based vignette browser;
RShowDoc(<basename>, package = "<pkg>")
displays a
“rendered” vignette (pdf or html).
## List vignettes from all *attached* packages vignette(all = FALSE) ## List vignettes from all *installed* packages (can take a long time!): vignette(all = TRUE) ## The grid intro vignette -- open it ## Not run: vignette("grid") # calling print() ## The same (conditional on existence of the vignettte). ## Note that 'package = *' is much faster in the case of many installed packages: if(!is.null(v1 <- vignette("grid", package="grid"))) { ## Not run: v1 # calling print(.) str(v1) ## Now let us have a closer look at the code ## Not run: edit(v1) # e.g., to send lines ... }# if( has vignette "installed") ## A package can have more than one vignette (package grid has several): vignette(package = "grid") if(interactive()) { ## vignette("rotated") ## The same, but without searching for it: vignette("rotated", package = "grid") }
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.