covrpage: Render covrpage

In yonicd/covrpage: Create a Readme Summary Page for GitHub testthat and covr Outputs

Render covrpage

Description

Render the template of the covrpage in the package directory.

Usage

covrpage(
  path = getwd(),
  preview = TRUE,
  auto_push = FALSE,
  update_badge = TRUE,
  vignette = FALSE
)

Arguments

path	path to package
preview	boolean, to open the output in viewer, Default: TRUE
auto_push	boolean, push to remote repo on exit, Default: FALSE
update_badge	boolean, locate badge in README and update with testthat results, Default: TRUE
vignette	boolean, if TRUE then the covrpage README will be copied as a vignette of the package, Default: FALSE

See Also

render

Other invoke: covrpage_ci(), covrpage_snapshot()

yonicd/covrpage documentation built on Feb. 23, 2023, 6:58 p.m.