use_description() creates a
DESCRIPTION file. Although mostly associated
with R packages, a
DESCRIPTION file can also be used to declare
dependencies for a non-package projects. Within such a project,
devtools::install_deps() can then be used to install all the required
packages. Note that, by default,
use_decription() checks for a
CRAN-compliant package name. You can turn this off with
check_name = FALSE.
usethis consults the following sources, in this order, to set
devtools option is consulted only for backwards compatibility and it's
recommended to switch to an option named "usethis.description".
Defaults built into usethis.
The fields discovered via options or the usethis package can be viewed with
If you create a lot of packages, consider storing personalized defaults as a
named list in an option named
"usethis.description". Here's an example of
code to include in
use_description(fields = list(), check_name = TRUE, roxygen = TRUE) use_description_defaults(package = NULL, roxygen = TRUE, fields = list())
A named list of fields to add to
Whether to check if the name is valid for CRAN and throw an error if not