Skip to contents

Downloads the pre-built .vtr for each named backbone into the taxify data directory (taxify_data_dir()), so subsequent taxify() calls match against them offline. taxify installs its default set automatically on first use (COL, GBIF, ITIS); call this to pre-install a specific set, add a backbone to the default, or refresh to the latest release.

Usage

install_backbones(backbones = NULL, verbose = TRUE)

Arguments

backbones

Character vector of backbone names (see list_backbones()). NULL (default) installs taxify's first-run set: COL, GBIF, and ITIS.

verbose

Logical. Default TRUE.

Value

Invisibly, the backbones now installed (those that downloaded successfully, or were already on disk), in priority order. A backbone whose refresh failed stays in the result with a warning, since its previous build is still usable.

Details

An installed backbone is compared against the manifest by the same check taxify() runs once per session: by content id where both sides record one, else by version. A backbone whose build differs from the one the manifest serves is replaced with the current release; one that is already current is left as it is. A build pinned by taxify_pin(), taxify_restore() or taxify_download(content_id = ) is never refreshed, and a message says so; taxify_pin(backbone, pin = FALSE) releases it. With options(taxify.offline = TRUE) nothing is compared and installed backbones are kept.

See also

list_backbones() for the full set with sizes, taxify().

Examples

if (FALSE) { # \dontrun{
# Pre-install a marine-focused set before matching:
install_backbones(c("col", "worms"))
} # }