vv: View a Vignette in the cmu202 Package

Description Usage Arguments Value Note See Also Examples

View source: R/view_vignette.R

Description

This function provides a wrapper for students to view vignettes only in the cmu202 package. view_vignette is intended to make the viewing of vignettes as painless as humanly possibe. Upon calling the function, the vignette will become viewable in the "viewer" tab of the "files" pane in RStudio.

Usage

1
vv("vignetteName")

Arguments

vignetteName

A string value indicating the name of the vignette you wish to see. Will return an error if the argument does not match any existing vignettes.

Value

vignette. An object of class vignette. If one simply wishes to view the vignette, calling the function without assignment will will display the vignette in the "viewer" tab.

Note

This command is identical to vignette("vignetteName", package = "cmu202")

See Also

vignette, vl, lv

Examples

1
# view_vignette("egg") ## Views the egg vignette.

frank113/cmu202 documentation built on July 17, 2020, 9:31 p.m.