Check system requirements for a project

Convenience wrapper around detect_project_packages() and check_packages().

Usage

check_project(
  path = ".",
  include_suggests = FALSE,
  platform = NULL,
  backend = c("auto", "bundled", "ppm", "pak"),
  ...
)

Arguments

path

Project path.

include_suggests

Whether to include Suggests from DESCRIPTION.

platform

Platform specification accepted by resolve_platform().

backend

One of "auto", "ppm", or "pak".

...

Passed to check_packages().

Value

A sysreqr_plan.

See also

Other preflight: check_library(), check_packages(), detect_project_packages()

Examples

project <- file.path(tempdir(), "demo-project")
dir.create(project, showWarnings = FALSE)
writeLines(
  c("Package: demo", "Imports: xml2"),
  file.path(project, "DESCRIPTION")
)
check_project(project, platform = "ubuntu-22.04", backend = "bundled")
#> System requirement preflight
#> 
#> Platform: Ubuntu 22.04
#> Package manager: apt
#> Backend: bundled
#> 
#> R packages checked:
#>   xml2
#> 
#> System packages to install: 
#>   libxml2-dev  needed by: xml2  status: unknown
#> 
#> Run:
#>   sudo apt-get update
#>   sudo apt-get install -y libxml2-dev
#>