Creates a package LICENSE and LICENSE.md 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_license(pkg_root, input_file = NULL, msg = "LICENSE file path:")

Arguments

pkg_root

Character string. Package root directory.

input_file

Character string. YAML file containing DESCRIPTION fields and entries.

msg

Character string. Prints optional message and output directory.

Details

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

THIS FUNCTION OVERWRITES EXISTING LICENSE and LICENSE.md FILES IN THE SPECIFIED PACKAGE ROOT DIRECTORY. USE WITH CAUTION.

Author

Ivan Jacob Agaloos Pesigan

Examples

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