getVignetteHeader: A function to read vignette header information
In DynDoc: Dynamic document tools

Description Usage Arguments Details Author(s)

View source: R/vigList.R

Given a vignette filename, will read in the vignette header metadata.

1 2	getVignetteHeader(vig, field) hasVigHeaderField(vig, field="VignetteIndexEntry")

`vig`	Vignette filename
`field`	A specific field to extract

The getVignetteHeader function will extract the metadata from a vignette file and return it as a named list, where the names of the list elements correspond to the metadata fields, and the elements themselves the values. If a specific field is desired, it can be specified with the 'field' argument.

The hasVigHeaderField function is a simple wrapper around getVignetteHeader and will most likely be removed in the very near future. It just is a boolean to report if a given header field exists or not.

Jeff Gentry

DynDoc documentation built on Nov. 8, 2020, 6:48 p.m.