vignetteInfo {tools}R Documentation

Basic Information about a Vignette

Description

Extract metadata from a vignette source file.

Usage

vignetteInfo(file)

Arguments

file

file name of the vignette.

Value

A list with the following character components:

file

the basename of the file.

title

the vignette title from ‘⁠\VignetteIndexEntry⁠’, possibly an empty string.

depends

a vector of package dependencies from ‘⁠\VignetteDepends⁠’, possibly of length 0.

keywords

a vector of keywords from ‘⁠\VignetteKeyword⁠’, possibly of length 0.

engine

the vignetteEngine, such as "utils::Sweave" or "knitr::knitr".

See Also

package_dependencies for recursive dependencies.

Examples

  gridEx <- system.file("doc", "grid.Rnw", package = "grid")
  vi <- vignetteInfo(gridEx)
  str(vi)
[Package tools version 4.4.1 Index]