R.rsp (version 0.9.17)

parseVignettes: Locates and parses all vignettes

Description

Locates and parses all vignettes.

Usage

parseVignettes(path=".", pattern="[.][^.~]*$", ...)

Arguments

path
The directory where to search for vignettes.
pattern
Filename pattern to locate vignettes.
...
Additional arguments passed to parseVignette().

Value

  • Returns a list where each element corresponds to an identified vignette source file. A file is considered to be a vignette source file if it has \Vignette.*{} markups in the top 50 lines. Each such vignette element consists of a named list with the parse \Vignette.*{} information.