shg_load_config: Load engine state and parameters from a YAML config file

In SmokingHistoryGenerator: R Package for the Smoking History Generator

Load engine state and parameters from a YAML config file

Description

Reads the YAML file, applies engine settings with useConfig(), then restores parameter tables via shg_load_params when the cache is missing or stale (using smok_params_source, mort_params_source, and mort_params_type stored in the file).

Usage

shg_load_config(shg, path)

shg_use_config_bundle(shg, path)

Arguments

shg	An SHGInterface instance.
path	Path to a YAML file produced by shg_save_config or compatible hand-written YAML.

Details

Private GitHub downloads use the GITHUB_PAT environment variable when needed (same as shg_load_params).

Value

The parsed config list (same object to pass to shg_run / runSim). Return value is visible so you can assign: config <- shg_load_config(shg, "my-run.yml").

See Also

shg_save_config, shg_run

SmokingHistoryGenerator documentation built on June 13, 2026, 1:08 a.m.