Install Artalytics packages

Programmatically install Artalytics packages using pak. By default, installs core packages only. Use include_extended = TRUE to also install extended packages.

Usage

install_artaverse(
  include_extended = getOption("artaverse.install_extended", FALSE),
  installer = NULL
)

Arguments

include_extended

Logical. If TRUE, install extended packages in addition to core packages. Can also be controlled via getOption("artaverse.install_extended", FALSE).

installer

Function to use for installation. Defaults to pak::pkg_install. Provide a custom function for testing or alternative installation methods.

Value

Invisibly returns a character vector of package references that were passed to the installer.

Details

This function requires the pak package to be installed. If pak is not available, the function will stop with an informative error message.

Package references are constructed as "artalytics/<package>" for installation from the artalytics GitHub organization.

See also

Other install: install_backend(), install_dev(), install_foundation(), install_frontend(), install_platform()

Examples

if (FALSE) { # \dontrun{
# Install core packages only
install_artaverse()

# Install core and extended packages
install_artaverse(include_extended = TRUE)

# Dry run: see what would be installed without actually installing
install_artaverse(installer = function(refs) print(refs))
} # }