Learn R Programming

srcpkgs (version 0.2)

pkg_roxygenise: roxygenize a source package if needed

Description

  • if the package has not changed (based on the md5sum file), does nothing

  • otherwise roxygenise the package using roxygen2::roxygenise

  • and update and save the new md5sum file

Usage

pkg_roxygenise(pkg_path, force = FALSE, quiet = FALSE, ...)

Value

if the roxygenation has been performed

Arguments

pkg_path

the package path, as a character

force

if force(d), do not use the md5-based system to detect package changes

quiet

whether to be quiet/silent

...

passed to devtools::document()

Details

  • N.B: has the side-effect of loading the package

Examples

Run this code
 pkg <- setup_and_get_dummy_srcpkg()
 pkg_roxygenise(pkg$path)

Run the code above in your browser using DataLab