pkg_pkgdown: Create a Boilerplate Package _pkgdown.yml

In jeksterslabds/jeksterslabRpkg: Package Utility Functions

Description

Creates a _pkgdown.yml build file.

Usage

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(s)

Ivan Jacob Agaloos Pesigan

Examples

## Not run: 
pkg_pkgdown(
  pkg_root = "~/boilerplatePackage",
  input_file = "DESCRIPTION.yml"
)

## End(Not run)

jeksterslabds/jeksterslabRpkg documentation built on Jan. 22, 2021, 11:43 p.m.