add_description: Create a DESCRIPTION file

Description Usage Arguments Value See Also Examples

View source: R/add_description.R

Description

This function creates a DESCRIPTION file at the root of the project based on a template (adapted from usethis). User credentials can be passed as arguments but it is recommended to store them in the .Rprofile file with set_credentials().

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
add_description(
  given = NULL,
  family = NULL,
  email = NULL,
  orcid = NULL,
  organisation = NULL,
  open = TRUE,
  overwrite = FALSE,
  quiet = FALSE
)

Arguments

given

a character of length 1

The given name of the package maintainer.

family

a character of length 1

The family name of the package maintainer.

email

a character of length 1

The email address of the package maintainer.

orcid

a character of length 1

The ORCID of the package maintainer.

organisation

a character of length 1

The name of the GitHub organisation to host the package. If NULL (default) the GitHub account will be used.

open

a logical value

If TRUE (default) the file is opened in the editor.

overwrite

a logical value

If a DESCRIPTION is already present and overwrite = TRUE, this file will be erased and replaced. Default is FALSE.

quiet

a logical value

If TRUE messages are deleted. Default is FALSE.

Value

None

See Also

Other create files: add_citation(), add_compendium(), add_license(), add_makefile(), add_package_doc(), add_readme_rmd(), add_testthat(), add_vignette()

Examples

1
2
3
4
## Not run: 
add_description(organisation = "MySociety")

## End(Not run)

rcompendium documentation built on March 24, 2021, 5:06 p.m.