# R Package for the Smoking History Generator

## Documentation for package ‘SmokingHistoryGenerator’ version 7.0.0

- DESCRIPTION file
- Package NEWS
- Package README

## Help Pages

SmokingHistoryGenerator-package | R Package for the Smoking History Generator
clear_params_cache | Clear the SHG parameter cache
getConfig | Get SHG Configuration
getReproConfig | Get Reproducibility Configuration
get_data_shape | get_data_shape method
LegacyRunWebVersion | LegacyRunWebVersion method
Rcpp_SHGInterface | Rcpp SHG Interface Class
Rcpp_SHGInterface-class | Class '"Rcpp_SHGInterface"'
runSimFromDataFrame | runSimFromDataFrame method
runSimFromFixedValues | runSimFromFixedValues method
SHGInterface | SHGInterface
shg_apply_config | Apply a sparse or complete configuration (defaults first, then overlay)
shg_clear_params_cache | Clear the SHG parameter cache
shg_config_bundle | Build a config list suitable for inspection or advanced serialization
shg_load_config | Load engine state and parameters from a YAML config file
shg_load_params | Load SHG smoking and mortality parameter bundles and configure the instance
shg_params_cache_dir | Return the directory where downloaded parameter sets are cached
shg_params_summary | Summarize currently configured SHG parameter tables
shg_reset_defaults | Reset an SHG instance to factory defaults
shg_run | Run a fixed cohort simulation from a config list
shg_save_config | Save a portable reproducibility config as YAML
shg_use_config_bundle | Load engine state and parameters from a YAML config file
shg_write_config_yaml | Write a configuration list to YAML
SmokingHistoryGenerator | R Package for the Smoking History Generator
useConfig | Use SHG Configuration