SmokingHistoryGenerator-package: R Package for the Smoking History Generator

In SmokingHistoryGenerator: R Package for the Smoking History Generator

R Package for the Smoking History Generator

Description

Efficient R interface to the Cancer Intervention and Surveillance Modeling Network (CISNET) Smoking History Generator microsimulation engine, which synthesizes individual smoking histories (initiation, cessation, intensity) and ages at death from calibrated initiation, cessation, cigarettes-per-day, and mortality tables. The wrapper exposes fixed-cohort and population data-frame simulation, multi-threaded segmentation, reproducible pseudo-random streams (L'Ecuyer RngStream MRG32k3a or Matsumoto–Nishimura Mersenne Twister), legacy CLI-style configuration files, and portable YAML configuration save/load with optional split smoking and mortality parameter bundles. Methods follow Jeon et al. (2012) <doi:10.1111/j.1539-6924.2011.01775.x>. Random number generators: Matsumoto and Nishimura (1998) <doi:10.1145/272991.272995>; L'Ecuyer (1999) <doi:10.1287/opre.47.1.159>; L'Ecuyer et al. (2002) <doi:10.1287/opre.50.6.1073.358>.

Details

Default calibrated inputs ship under system.file("extdata", "2018", package = "SmokingHistoryGenerator") as smoking/*.csv and mortality/*.csv (NHIS-1965-2018 csv-partial). Set input_data_folder and per-table filenames accordingly. Wide legacy .txt tables remain supported. Full NHIS-style tables are distributed separately (Zenodo; the installed README is at system.file("README.md", package = "SmokingHistoryGenerator")).

Author(s)

John Clarke [aut, cre] (Author and maintainer of SHG R package wrapper for the SHG), Ben Racine [aut] (Co-author of the original SHG), Martin Krapcho [aut] (Co-author of the original SHG), Alexander Gaenko [aut] (Co-author of the original SHG), Makoto Matsumoto [ctb, cph] (Mersenne Twister mt19937 (src/mersenne_class.*); copyright notice in source), Takuji Nishimura [ctb, cph] (Mersenne Twister mt19937 (src/mersenne_class.*); copyright notice in source), Pierre L'Ecuyer [ctb, cph] (RngStream MRG32k3a (src/RngStream.*); copyright notice in source)

Maintainer: John Clarke <[e-mail]>

References

CISNET modelling applications that use the Smoking History Generator are listed on the CISNET website at https://cisnet.cancer.gov/.

See Also

R package source: https://github.com/NCI-CISNET/shg-r

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