Skip to contents

Preflight checks

Resolve the system packages your R packages need on a given platform.

check_library()
Check system requirements for installed R packages
check_packages()
Check system requirements for R packages
check_project()
Check system requirements for a project
detect_project_packages()
Detect R packages used by a project

Platform detection

Detect or specify the platform under inspection.

detect_package_manager()
Detect the platform package manager
detect_platform()
Detect the current platform
resolve_platform()
Resolve a platform specification

Output and commands

Turn a plan into install commands, Docker snippets, GitHub Actions YAML, or administrator request templates.

admin_request()
Create an administrator request
dockerfile()
Generate Dockerfile lines
github_actions() gha()
Generate a GitHub Actions snippet
install_command()
Generate an installation command

Diagnose failed installs

Match installation logs and failed package names to likely missing system packages.

check_error()
Check the most recent install error for likely system requirements
diagnose_failed_packages()
Diagnose failed R packages
diagnose_log() diagnose_install_log()
Diagnose an R package installation log

Posit Package Manager

Query the Posit Package Manager API and build repository URLs.

check_ppm()
Check Posit Package Manager support
ppm_platforms()
List Posit Package Manager platforms
ppm_repo()
Build a Posit Package Manager repository URL
ppm_sysreqs()
Query Package Manager system requirements
use_ppm()
Configure Package Manager repository options

File writers

Persist plans as JSON, Markdown, install scripts, or Dockerfile snippets.

as_install_plan()
Return backend install plan data
write_dockerfile_snippet()
Write a Dockerfile snippet
write_install_script()
Write an install script
write_json()
Write a sysreqr plan as JSON
write_report()
Write a Markdown report

The plan object

Introspect and coerce sysreqr_plan objects.

as_data_frame()
Coerce a plan to a plain data frame
is_sysreqr_plan()
Test whether an object is a sysreqr plan
print(<sysreqr_plan>)
Print a sysreqr plan

Setup advice

Beginner-focused setup checklists and explanations.

explain()
Explain system requirements
print(<sysreqr_setup_advice>)
Print setup advice
setup_advice()
Get beginner setup advice for R package installation on Linux