Renders R and R Markdown files in the package directory.

pkg_render(
  pkg_root = getwd(),
  readme = TRUE,
  vignettes = TRUE,
  tests = TRUE,
  par = FALSE,
  ncores = NULL
)

Arguments

pkg_root

Character string. Package root directory.

readme

Logical. Render README.Rmd.

vignettes

Logical. Render vignettes/*.Rmd|*.R.

tests

Logical. Render tests/testhat/*.Rmd|*.R.

par

Logical. If TRUE, use multiple cores.

ncores

Integer. Number of cores to use if par = TRUE. If unspecified, defaults to detectCores() - 1.

Author

Ivan Jacob Agaloos Pesigan

Examples

if (FALSE) { pkg_render( pkg_root = "~/boilerplatePackage", readme = TRUE, vignettes = TRUE, tests = TRUE, par = FALSE ) }