vignetteInfo
Extract Metadata from Vignette Source File

### Description

Parse the %\Vignette* entries in the source file of a vignette.

### Usage

    vignetteInfo(file)

### Arguments

file | The source file for a vignette. It should contain lines of the form "%\Vignette'name'{'value'}", e.g. "%\VignetteEngine{knitr::knitr}".

Value
A list of five named entries.

- file: The base name (not including the directory) of the vignette.
- title: The value of the "\VignetteIndexEntry" macro, or the empty string if that macro is not in the file.
- depends: The comma-separated elements of the value of the "\VignetteDepends" macro, or a zero-length character vector if that macro is not in the file.
- keywords: The values of the "\VignetteKeyword" macros or a zero-length character vector if no such macros are in the file.
- engine: The value of the "\VignetteEngine" macro, or "utils::Sweave" if that macro is not in the file.

See Also
vignetteEngine
Examples

    tools::vignetteInfo(system.file(mustWork=TRUE, package="RinR",
        "doc", "RinR.Rmd"))

Package tools version 6.1.5-18
Package Index