getVignette: A function to handle vignette files

View source: R/vignetteClass.R

getVignetteR Documentation

A function to handle vignette files

Description

This function will take a vignette file and return a Vignette object in R which can be manipulated further.

Usage

getVignette(vigPath, eval = TRUE)

Arguments

vigPath

The file path of the vignette file

eval

Whether or not to evaluate the code chunks

Details

This function should still be considered experimental

Value

A valid Vignette object representing this vignette

Author(s)

Jeff Gentry

See Also

Vignette-class


Bioconductor/DynDoc documentation built on Nov. 2, 2024, 6:34 a.m.