set_description_default: Set default Values for the 'DESCRIPTION' file

In PetterHopp/NVIpackager: Tools to facilitate Development of NVIverse Packages

Set default Values for the DESCRIPTION file

Description

Set default Values for the DESCRIPTION file. The values are saved as the option usethis.description.

Usage

set_description_default(
  pkg = stringi::stri_extract_last_words(usethis::proj_path()),
  license_keyword = "BSD_3_clause"
)

Arguments

pkg	[character(1)] The package name. Defaults to stringi::stri_extract_last_words(usethis::proj_path()).
license_keyword	[character(1)] The keyword for the package's license in accord with list of license keywords. Defaults to "BSD_3_clause".

Details

These options are used when creating the package skeleton using create_NVIpkg_skeleton. The following standard values are given:

• "Petter Hopp" with role c("aut", "cre")

• "Norwegian Veterinary Institute" with role = "cph"

• registertype (categories for locations and addresses)

• URL: "https://github.com/NorwegianVeterinaryInstitute/NVIpkg"

• BugReports: "https://github.com/NorwegianVeterinaryInstitute/NVIpkg/issues"

• License: license_keyword "+ file LICENSE",

• Language: "en-GB",

• Depends:= "R (>= 4.0.0)"

The function accepts a short list of the listed license keywords accepted at Cran in "./share/license/license.db" in R home. If you need any other license than in the short list, submit an issue.

Value

None. Writes the options to the option usethis.description.

Author(s)

Petter Hopp [e-mail]

Examples

## Not run: 
library(NVIpackager)
set_description_default()

## End(Not run)


# set up standards for DESCRIPTION file ----

PetterHopp/NVIpackager documentation built on Sept. 14, 2024, 1:24 a.m.