pkg_description: Create a Package 'DESCRIPTION' File

In jeksterslabds/jeksterslabRpkg: Package Utility Functions

Description

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.

Usage

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.

Details

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.

Author(s)

Ivan Jacob Agaloos Pesigan

Examples

## Not run: 
pkg_description(
  pkg_dir = getwd(),
  input_file = "DESCRIPTION.yml"
)

## End(Not run)

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