usethis (version 1.3.0)

use_description: Create a default DESCRIPTION file for a package.

Description

If you create a lot of packages, you can override the defaults by setting option "usethis.description" to a named list. Here's an example of code one could include in .Rprofile:

options(
  usethis.name = "Jane Doe",
  usethis.description = list(
    `Authors@R` = 'person("Jane", "Doe", email = "[e-mail]", role = c#' ("aut", "cre"))',
    License = "MIT + file LICENSE",
    Version = "0.0.0.9000"
  )
)

Usage

use_description(fields = NULL)

Arguments

fields

A named list of fields to add to DESCRIPTION, potentially overriding the defaults. If NULL, retrieved from getOption("usethis.description"), and (for backward compatibility) from getOption("devtools.desc").

Examples

# NOT RUN {
use_description()
# }