API Reference

Packages

Package management and renv integration

Common Functions

These are the most commonly used functions in this category:

packages_install()

Installs all packages defined in the configuration that are not already installed. This is the same

packages_restore()

Wrapper around `renv::restore()` that requires Framework's renv integration to be enabled first.

Other Functions

Function Description
packages_list() Lists all packages defined in the configuration, showing the package name, version pin (if specifie
packages_snapshot() Wrapper around `renv::snapshot()` that requires Framework's renv integration to be enabled first.
packages_status() Wrapper around `renv::status()` that requires Framework's renv integration.
packages_update() Updates packages defined in the configuration. If renv is enabled, uses renv::update(). Otherwise,
renv_disable() Deactivates renv integration while preserving renv.lock for future use. Removes the `.framework_ren
renv_enable() Initializes renv integration for the current Framework project. This: - Creates `.framework_renv_en
renv_enabled() Determines whether renv integration is active by checking for the `.framework_renv_enabled` marker

All Functions

Function Description
packages_install() Installs all packages defined in the configuration that are not already installed. This is the same
packages_list() Lists all packages defined in the configuration, showing the package name, version pin (if specifie
packages_restore() Wrapper around `renv::restore()` that requires Framework's renv integration to be enabled first.
packages_snapshot() Wrapper around `renv::snapshot()` that requires Framework's renv integration to be enabled first.
packages_status() Wrapper around `renv::status()` that requires Framework's renv integration.
packages_update() Updates packages defined in the configuration. If renv is enabled, uses renv::update(). Otherwise,
renv_disable() Deactivates renv integration while preserving renv.lock for future use. Removes the `.framework_ren
renv_enable() Initializes renv integration for the current Framework project. This: - Creates `.framework_renv_en
renv_enabled() Determines whether renv integration is active by checking for the `.framework_renv_enabled` marker