get_cran_package_system_dependencies: Get CRAN packages' system dependencies

View source: R/package_management.R

get_cran_package_system_dependenciesR Documentation

Get CRAN packages' system dependencies

Description

[Experimental]

This function extracts the list of CRAN packages within a renv lock file, querying the RStudio Package Manager API, from the Rstudio Public Package Manager to get a list of external system libraries these packages depend on.

The returned list of system dependencies are intended to help create a Docker file used to build a Docker image for a R project.

Usage

get_cran_package_system_dependencies(
  renv_lock_path,
  distribution = "ubuntu",
  release = NULL
)

Arguments

renv_lock_path

Path to the renv.lock file.

distribution

Operating system to be used by the Docker image, with ubuntu as the default. Other operating systems include centos.

release

Release version of the operating system. This may default to the latest operating system release.

Value

An httr response converted to a tibble containing the package names and their system dependencies.

See Also

The function is a collation and modification of the functions in the getsysres package written by David Neuzerling.

Examples

## Not run: 
get_cran_package_system_dependencies(renv_lock_path = "renv.lock")

## End(Not run)

gcfrench/store documentation built on May 17, 2024, 5:52 p.m.