check_downstream_job: Check & install downstream job

View source: R/rstudio_jobs.R

check_downstream_jobR Documentation

Check & install downstream job

Description

Check & install downstream job

Usage

check_downstream_job(
  project = ".",
  verbose = 1,
  create_args = list(renv_profile = Sys.getenv("RENV_PROFILE")),
  ...
)

Arguments

project

(character) If project_type is local then directory of project (for which to calculate the dependency structure); must be a git repository. If project_type is repo@host then should be character of the form ⁠openpharma/stageddeps.food@https://github.com⁠ If host is not included in the string then the default ⁠https://github.com⁠ is assumed.

verbose

(numeric)
verbosity level, incremental; (0: None, 1: packages that get installed + high-level git operations, 2: includes git checkout infos)

create_args

named list - additional arguments passed to dependency_table function

...

Arguments passed on to check_downstream

distance

(numeric) additional filter to only install downstream packages at most this distance from the dependency_structure$current_pkg (advanced use only)

check_args

(list) arguments passed to rcmdcheck

only_tests

(logical) whether to only run tests (rather than checks)

dep_structure

(dependency_structure) output of function dependency_table; uses dep_structure$table to infer the packages to apply action to and infer installation order; uses dep_structure$deps to infer upstream dependencies

install_external_deps

logical to describe whether to install external dependencies of package using remotes::install_deps() (or renv::install() if inside an renv environment) .

upgrade

argument passed to remotes::install_deps(), defaults to 'never'. Ignored if inside an renv environment.

package_list

(character) If not NULL, an additional filter, only packages on this list will be considered and their dependencies installed if needed (advanced usage only).

dry

(logical) dry run that outputs what would happen without actually doing it.

See Also

check_downstream

Examples

## Not run: 
check_downstream_job(check_args = Sys.getenv("RCMDCHECK_ARGS"))
check_downstream_job(
  check_args = Sys.getenv("RCMDCHECK_ARGS"),
  list(create_arg = list(ref = "6_makegraph@main"))
)
check_downstream_job(only_tests = TRUE)

## End(Not run)

openpharma/staged.dependencies documentation built on Aug. 27, 2023, 10:17 a.m.