canprot (version 1.0.0)

mkvig: Compile and View Vignettes from the Command Line

Description

This function compiles the indicated vignette and opens it in the browser.

Usage

mkvig(vig = NULL)

Arguments

vig

character, name of a vignette without .Rmd extension

Details

Starting with version 0.2, in order to reduce package space and check time, pre-built vignettes are not included in the package. This function was added to compile the vignettes on demand and view them in a browser.

The available vignettes are listed here:

• Cell culture -- hypoxia, secreted, osmotic_bact, osmotic_euk, osmotic_halo, glucose, 3D

• Cancer -- breast, colorectal, liver, lung, pancreatic, prostate

Note that pandoc (including pandoc-citeproc), as a system dependency of rmarkdown, must be available. See rmarkdown's pandoc vignette (https://CRAN.R-project.org/package=rmarkdown/vignettes/pandoc.html) for installation tips.

See Also

The vignettes can also be run using e.g. demo("glucose"), and through the interactive help system (help.start > Packages > canprot > Code demos).

Examples

# NOT RUN {
mkvig("colorectal")
# }