pkg_render: Render 'R' and 'R' Markdown Files in the Package Directory

In jeksterslabds/jeksterslabRpkg: Package Utility Functions

Description

Renders R and R Markdown files in the package directory.

Usage

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(s)

Ivan Jacob Agaloos Pesigan

Examples

## Not run: 
pkg_render(
  pkg_root = "~/boilerplatePackage",
  readme = TRUE,
  vignettes = TRUE,
  tests = TRUE,
  par = FALSE
)

## End(Not run)

jeksterslabds/jeksterslabRpkg documentation built on Jan. 22, 2021, 11:43 p.m.