package-dev: Package development utilities
In heavywatal/rwtl: Personal R package

document_install

R Documentation

Package development utilities

Description

document_install() is a quick shortcut of devtools::install() following devtools::document().

chk() and tst() are thin wrappers of devtools::check() and testthat::test_local().

Usage

document_install(pkg = ".", build = FALSE, upgrade = FALSE, ...)

chk(pkg = ".", install = FALSE, vignettes = FALSE, args = "--timings", ...)

tst(pkg = ".", ...)

Arguments

`pkg`	The package to use, can be a file path to the package or a package object. See `as.package()` for more information.
`build`	if `TRUE` `pkgbuild::build()`s the package first: this ensures that the installation is completely clean, and prevents any binary artefacts (like ‘.o’, `.so`) from appearing in your local package directory, but is considerably slower, because every compile has to start from scratch.
`upgrade`	Should package dependencies be upgraded? One of "default", "ask", "always", or "never". "default" respects the value of the `R_REMOTES_UPGRADE` environment variable if set, and falls back to "ask" if unset. "ask" prompts the user for which out of date packages to upgrade. For non-interactive sessions "ask" is equivalent to "always". `TRUE` and `FALSE` are also accepted and correspond to "always" and "never" respectively.
`...`	additional arguments passed to `remotes::install_deps()` when installing dependencies.
`install`	If FALSE, add `--no-install` to `args`
`vignettes`	If FALSE, add `--ignore-vignettes` to `args`
`args`	An optional character vector of additional command line arguments to be passed to `⁠R CMD INSTALL⁠`. This defaults to the value of the option `"devtools.install.args"`.