update_model_dir_path-methods: Updates model directory path for ensemble objects.

update_model_dir_pathR Documentation

Updates model directory path for ensemble objects.

Description

Updates the model directory path of a familiarEnsemble object.

Usage

update_model_dir_path(object, dir_path, ...)

## S4 method for signature 'familiarEnsemble'
update_model_dir_path(object, dir_path)

## S4 method for signature 'ANY'
update_model_dir_path(object, dir_path)

Arguments

object

A familiarEnsemble object, or one or more familiarModel objects that will be internally converted to a familiarEnsemble object. Paths to such objects can also be provided.

dir_path

Path to the directory where models are stored.

...

Unused arguments.

Details

Ensemble models created by familiar are often written to a directory on a local drive or network. In such cases, the actual models are detached, and paths to the models are stored instead. When the models are moved from their original location, they can no longer be found and attached to the ensemble. This method allows for pointing to the new directory containing the models.

Value

A familiarEnsemble object.


familiar documentation built on Sept. 30, 2024, 9:18 a.m.