install_models: Install allometric models from the models repository

View source: R/install.R

install_modelsR Documentation

Install allometric models from the models repository

Description

Allometric models are stored in a remote repository located on GitHub located here. The user must install these models themselves using this function. This function clones the models repository within the allometric package directory and constructs a local dataframe containing the models. This dataframe is stored in the global environment variable allometric_models upon completion of the function. Refer to allometric::allometric_models for further information.

Usage

install_models(redownload = FALSE, ignore_cache = FALSE, verbose = TRUE)

Arguments

redownload

If TRUE, models are re-downloaded from the remote repository.

ignore_cache

If TRUE, models are re-installed regardless of their installation timestamp. Otherwise, only newly modified model files are reran. This is primarily for development purposes.

verbose

If TRUE, print verbose messages as models are installed.

Value

No return value, installs models into the package directory.


allometric documentation built on Nov. 8, 2023, 1:07 a.m.