hgutils (version 0.2.11)

crossref_description: Set imports for DESCRIPTION file

Description

Update the DESCRIPTION file with all imported packages stated in the source code.

Usage

crossref_description(
  skip_prompt = FALSE,
  update = TRUE,
  use_version_numbers = TRUE,
  rversion = "DEPENDENCIES_VERSION"
)

Arguments

skip_prompt

whether to skip the confirmation prompt to change the DESCRIPTION file. Defaults to FALSE.

update

whether the DESCRIPTION file should be updated. Defaults to TRUE.

use_version_numbers

whether package version numbers should be included in the DESCRIPTION file. Defaults to TRUE.

rversion

version of R to be used in the DESCRIPTION file. Can be DEPENDENCIES_VERSION for the latest version in the package dependencies, LATEST_VERSION for the current R version or any valid version number.

Value

Invisibly returns a list with the current R version, the R version obtained from dependencies and packages names (including version numbers).

See Also

numeric_version

Other developer functions: generic_implementations(), load_packages(), update_settings(), valid_pkgname()

Examples

# NOT RUN {
crossref_description(skip_prompt=TRUE)
# }