Skip to content

Split smoking/mortality parameter bundles and CRAN review fixes#27

Draft
john-clarke wants to merge 13 commits into
6.5.3-1.0.1-rcfrom
split-out-mortality-params
Draft

Split smoking/mortality parameter bundles and CRAN review fixes#27
john-clarke wants to merge 13 commits into
6.5.3-1.0.1-rcfrom
split-out-mortality-params

Conversation

@john-clarke

@john-clarke john-clarke commented May 27, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Load separate smoking and mortality parameter zips (smok_params_source, mort_params_source, mort_params_type) instead of a single combined bundle; reject legacy combined-bundle configs with clear errors.
  • Wire split sources through C++ provenance, YAML config save/load, shg_run, and tests (split fixtures + updated testthat coverage).
  • Address CRAN reviewer feedback: expanded DESCRIPTION, Authors@R ctb/cph for vendored Mersenne Twister and RngStream code, \value documentation, and runnable examples using bundled extdata.

Test plan

  • testthat::test_local(..., load_package = "installed") — 392 passed, 0 failed
  • rcmdcheck::rcmdcheck(args = c("--no-manual", "--as-cran"), error_on = "warning") — 0 errors, 0 warnings
  • CI R CMD check (all OS) on this PR
  • Confirm portable YAML round-trip with split zips on a clean install

Made with Cursor

john-clarke and others added 13 commits May 27, 2026 13:37
Replace single-zip load_params with smoking_url and mortality_url, merge shg-params params/ layout into engine paths, and track smok_params_source, mort_params_source, and mort_params_type on SHGInterface (6.5.3-1.0.1).

Co-authored-by: Cursor <cursoragent@cursor.com>
Portable YAML and shg_apply_config require smok_params_source and mort_params_source; reject removed params_bundle_source and params_mortality keys.

Co-authored-by: Cursor <cursoragent@cursor.com>
Ship shg-params-style smoking and mortality zips plus a script to regenerate them from the legacy combined fixture.

Co-authored-by: Cursor <cursoragent@cursor.com>
Update README, config guides, NEWS, and roxygen-generated man pages for the new config keys and load_params API.

Co-authored-by: Cursor <cursoragent@cursor.com>
Point portable workflow and sample configs at separate smok and mort test zips.

Co-authored-by: Cursor <cursoragent@cursor.com>
Matsumoto and Nishimura (Mersenne Twister) and L'Ecuyer (RngStream) are
acknowledged per CRAN policy for third-party code in the simulation engine.

Co-authored-by: Cursor <cursoragent@cursor.com>
Rewrites the one-paragraph summary without a leading "This package" opener,
documents core functionality, and adds DOIs for the SHG chapter and RNG sources.

Co-authored-by: Cursor <cursoragent@cursor.com>
Adds durable roxygen in R/shg-rcpp-docs.R and regenerates help pages for
SHGInterface, simulation methods, and config helpers flagged in review.

Co-authored-by: Cursor <cursoragent@cursor.com>
Replaces dontrun with bundled extdata examples or donttest, removes
commented-out example code, and drops library() calls from help examples.

Co-authored-by: Cursor <cursoragent@cursor.com>
Add cph alongside ctb for Matsumoto, Nishimura, and L'Ecuyer with comments
pointing to the embedded source files. Remove donttest wrappers; bundled
extdata examples finish in under five seconds on check hardware.

Co-authored-by: Cursor <cursoragent@cursor.com>
Add shg-params-style bundled-smok.zip and bundled-mort.zip under
inst/extdata/2018, point demos at system.file paths, and rebuild those
zips when refreshing the NHIS csv-partial.

Co-authored-by: Cursor <cursoragent@cursor.com>
Expand ?shg_run value text for the four-component attach_run_info list,
cross-link from Rcpp sim methods, keep useConfig examples only in
shg-rcpp-docs.R, and drop duplicate @return/@examples from wrapper.cpp.

Co-authored-by: Cursor <cursoragent@cursor.com>
Document shg_params_cache_dir and shg_clear_params_cache return values,
regenerate Rd, and record the exported-\value requirement in AGENTS.md.

Co-authored-by: Cursor <cursoragent@cursor.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant