This function creates a DESCRIPTION
file at the root of the project. This
file contains metadata of the project. Some information (title, description,
version, etc.) must be edited by hand. For more information:
https://r-pkgs.org/description.html.
User credentials can be passed as arguments but it is recommended to store
them in the .Rprofile
file with set_credentials()
.
add_description(
given = NULL,
family = NULL,
email = NULL,
orcid = NULL,
organisation = NULL,
open = TRUE,
overwrite = FALSE,
quiet = FALSE
)
A character of length 1. The given name of the project maintainer.
A character of length 1. The family name of the project maintainer.
A character of length 1. The email address of the project maintainer.
A character of length 1. The ORCID of the project maintainer.
A character of length 1. The name of the GitHub
organisation to host the package. If NULL
(default) the GitHub account
will be used.
A logical value. If TRUE
(default) the file is opened in the
editor.
A logical value. If a DESCRIPTION
is already present and
overwrite = TRUE
, this file will be erased and replaced. Default is
FALSE
.
A logical value. If TRUE
messages are deleted. Default is
FALSE
.
No return value.
Other create files:
add_citation()
,
add_code_of_conduct()
,
add_compendium()
,
add_contributing()
,
add_dockerfile()
,
add_license()
,
add_makefile()
,
add_package_doc()
,
add_readme_rmd()
,
add_renv()
,
add_testthat()
,
add_vignette()
if (FALSE) {
add_description(organisation = "MySociety")
}