Creates a _pkgdown.yml build file.

pkg_pkgdown(pkg_root, input_file = NULL, msg = "_pkgdown.yml 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, and the argument pkgdown = TRUE is specified, this function will be called.

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

Author

Ivan Jacob Agaloos Pesigan

Examples

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