proj_use_description: Create DESCRIPTION file

In ijlyttle/projthis: Lightweight Framework for Analysis Development

Create DESCRIPTION file

Description

To create a DESCRIPTION file for your existing project, this function calls usethis::use_description() and, optionally, proj_update_deps() to update the package-dependency declaration.

Usage

proj_use_description(fields = list(), update_deps = TRUE)

Arguments

fields	A named list of fields to add to DESCRIPTION, potentially overriding default values. See use_description() for how you can set personalized defaults using package options
update_deps	logical indicates to update package-dependency declaration in DESCRIPTION file.

Value

Invisible NULL, called for side effects.

Examples

# not run because it produces side effects
if (FALSE) {
  proj_use_description()
}

ijlyttle/projthis documentation built on Aug. 18, 2022, 11:25 a.m.