Skip to contents

Write PopulationSim settings.yaml file

popsim_make_settings.Rd

Generates and writes the PopulationSim settings.yaml configuration file for a given run. Use when preparing synthetic population runs with custom or updated settings.

Usage

popsim_make_settings(settings, run_label, popsim_settings = NULL)

Source

PopulationSim configuration logic and project settings.

Arguments

settings

list. Project settings, must include working_dir (character).

run_label

character(1). Label for the run, used in output path.

popsim_settings

list or NULL. PopulationSim settings; if NULL, loads defaults.

Value

NULL. Side effect: writes settings.yaml to disk in run's configs directory.

Details

  • Loads default PopulationSim settings if popsim_settings is not provided.

  • Updates settings with project-specific values from settings.

  • Creates required subdirectories (configs/) if missing.

  • Writes the updated settings.yaml file to <working_dir>/<run_label>/configs/settings.yaml.

  • Assumes input is a list of settings; does not modify by reference.

  • Side effect: writes configuration file to disk.

Settings

  • working_dir (direct): output directory for PopulationSim files. Must be present in settings.

  • popsim_setting_updates (optional): manual overrides for PopulationSim settings.

See also

popsim_settings_defaults, popsim_settings_updates

Other PopulationSim IO: popsim_make_control_config(), popsim_make_geoxwalk(), popsim_make_input_data(), popsim_make_weights(), popsim_search(), popsim_search_stats(), popsim_settings_updates()

Examples

## Not run:
popsim_make_settings(settings, 'run1')
#> Error: object 'settings' not found
## End(Not run)