get_cached_results: Retrieve cached results from previously saved 'Experiment'.

View source: R/experiment-helpers.R

get_cached_resultsR Documentation

Retrieve cached results from previously saved Experiment.

Description

Read in cached results from disk from a previously saved Experiment run.

Usage

get_cached_results(experiment, results_type, verbose = 0)

Arguments

experiment

An Experiment object.

results_type

Character string indicating the type of results to read in. Must be one of "experiment", "experiment_cached_params", "fit", "eval", or "viz".

verbose

Level of verbosity. Default is 1, which prints out messages after major checkpoints in the experiment. If 2, prints additional debugging information for warnings and messages from user-defined functions (in addition to error debugging information). If 0, no messages are printed other than user-defined function error debugging information.

Value

The cached results, specifically the cached Experiment object if results_type = "experiment", the cached fit results if results_type = "fit", the cached evaluation results if results_type = "eval", the cached visualization results if results_type = "viz", and the experiment parameters used in the cache if results_type = "experiment_cached_params".

Examples

## Not run: 
fit_results <- get_cached_results(experiment, "fit")
eval_results <- get_cached_results(experiment, "eval")
viz_results <- get_cached_results(experiment, "viz")
cached_params <- get_cached_results(experiment, "experiment_cached_params")
## End(Not run)


Yu-Group/simChef documentation built on March 25, 2024, 3:22 a.m.