Create a Boilerplate Package README File

Creates a boilerplate package README.Rmd file by extracting information from an external yml input_file. See system.file("extdata", "DESCRIPTION.yml", package = "jeksterslabRpkg", mustWork = TRUE) for the input_file template.

pkg_readme(pkg_root, input_file = NULL, msg = "README.Rmd file path:")

Arguments

pkg_root	Character string. Package root directory.
input_file	Character string. YAML file containing DESCRIPTION fields and entries.
msg	Character string. Optional message. If supplied, prints msg dir/fn.

Details

Note that if pkg_create() is used, this function will be called.

THIS FUNCTION OVERWRITES AN EXISTING README.Rmd FILE IN THE SPECIFIED PACKAGE ROOT DIRECTORY. USE WITH CAUTION.

Author

Ivan Jacob Agaloos Pesigan

Examples

if (FALSE) {
pkg_readme(
  pkg_root = "~/boilerplatePackage",
  input_file = "DESCRIPTION.yml"
)
}