Learn R Programming

canprot (version 1.1.0)

mkvig: Compile and View Vignettes from the Command Line

Description

Compile the indicated vignette and open it in the browser.

Usage

mkvig(vig = NULL)

Arguments

vig

character, name of a vignette without .Rmd extension

Details

In order to reduce package space and check time, pre-built vignettes are not included in the package. mkvig is a convenience function to compile the vignettes on demand and view them in a browser.

The available vignettes for mkvig 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, is required to build the vignettes.

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

Run this code
# NOT RUN {
mkvig("colorectal")
# }

Run the code above in your browser using DataLab