vignette {utils}R Documentation

View or List Vignettes

Description

View a specified vignette, or list the available ones.

Usage

vignette(topic, package = NULL, lib.loc = NULL)

## S3 method for class 'vignette':
print(x, ...)
## S3 method for class 'vignette':
edit(name, ...)

Arguments

topic a character string giving the (base) name of the vignette to view. If omitted, all available vignettes are listed.
package a character vector with the names of packages to search through, or NULL in which case all available packages in the library trees specified by lib.loc are searched.
lib.loc a character vector of directory names of R libraries, or NULL. The default value of NULL corresponds to all libraries currently known.
x, name Object of class vignette.
... Ignored by the print method, passed on to file.edit by the edit method.

Details

Function vignette returns an object of the same class, the print method opens a viewer for it. Currently, only PDF versions of vignettes can be viewed. If several vignettes have PDF versions with base name identical to topic, the first one found is used. The edit method extracts the R code from the vignette to a temporary file and opens the file in an editor.

If no topics are given, the available vignettes are listed. The corresponding information is returned in an object of class "packageIQR". The structure of this class is experimental.

Examples

## List vignettes in all attached packages
vignette()

## Not run: 
## Open the grid intro vignette
vignette("grid")

## The same
v1 <- vignette("grid")
print(v1)

## Now let us have a closer look at the code
edit(v1)

## A package can have more than one vignette (package grid has several):
vignette(package="grid")
vignette("rotated")
## The same, but without searching for it:
vignette("rotated", package="grid")
## End(Not run)

[Package utils version 2.1.0 Index]