Create a Package DESCRIPTION File — pkg_description • jeksterslabRpkg

Creates a package DESCRIPTION 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_description(
  pkg_dir = getwd(),
  input_file = NULL,
  add = NULL,
  msg = "DESCRIPTION file path:"
)

Arguments

pkg_dir	Character string. Directory where the package is initialized.
input_file	Character string. `YAML` file containing `DESCRIPTION` fields and entries.
add	Character string. Additional entries to the `DESCRIPTION` file not included in `input_file`
msg	Character string. Prints optional message and output directory.

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

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

Ivan Jacob Agaloos Pesigan

if (FALSE) {
pkg_description(
  pkg_dir = getwd(),
  input_file = "DESCRIPTION.yml"
)
}