usethis: use_package – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

use_package

Depend on another package

Description

use_package() adds a CRAN package dependency to DESCRIPTION and offers a little advice about how to best use it. use_dev_package() adds a dependency on an in-development package, adding the dev repo to Remotes so it will be automatically installed from the correct location.

Usage

use_package(package, type = "Imports", min_version = NULL)

use_dev_package(package, type = "Imports", remote = NULL)

Arguments

`package`	Name of package to depend on.
`type`	Type of dependency: must be one of "Imports", "Depends", "Suggests", "Enhances", or "LinkingTo" (or unique abbreviation). Matching is case insensitive.
`min_version`	Optionally, supply a minimum version for the package. Set to `TRUE` to use the currently installed version.
`remote`	By default, an `OWNER/REPO` GitHub remote is inserted. Optionally, you can supply a character string to specify the remote, e.g. `"gitlab::jimhester/covr"`, using any syntax supported by the remotes package.

Examples

## Not run: 
use_package("ggplot2")
use_package("dplyr", "suggests")
use_dev_package("glue")

## End(Not run)

usethis

Automate Package and Project Setup

v2.0.1

MIT + file LICENSE

Authors

Hadley Wickham [aut] (<https://orcid.org/0000-0003-4757-117X>), Jennifer Bryan [aut, cre] (<https://orcid.org/0000-0002-6983-2759>), RStudio [cph, fnd]

Initial release