Skip to contents

Run PopulationSim and generate final weights

popsim_make_weights.Rd

Executes the Python-based PopulationSim model in a specified working directory, generating synthetic population weights. Use for final expansion after input preparation.

Usage

popsim_make_weights(
  settings,
  run_label = NULL,
  popsim_dir = NULL,
  showoutput = TRUE,
  save_hash = TRUE
)

Arguments

settings

list. Must include 'working_dir', 'python_env'.

run_label

character(1), optional. Used to construct working directory.

popsim_dir

character(1), optional. Path to existing working directory.

showoutput

logical(1). Display PopulationSim output in console.

save_hash

logical(1). Save input hash to skip rerun if unchanged.

Value

NULL. Side effect: runs PopulationSim and writes outputs to disk.

Details

  • Builds working directory from settings and run label.

  • Creates required subdirectories if missing.

  • Checks input hashes to skip rerun if unchanged.

  • Runs PopulationSim via configured Python environment.

  • Saves output and input hash to disk.

  • Returns NULL; side effect is output files.

  • Assumes settings include 'working_dir', 'python_env'.

Settings

  • working_dir (direct): output directory for PopulationSim files.

  • python_env (direct): Python environment for PopulationSim.

See also

popsim_make_geoxwalk, popsim_make_input_data

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

Examples

## Not run:
popsim_make_weights(settings, run_label = 'run1')
#> Error: object 'settings' not found