-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Refactor simulation architecture #66
Conversation
…tbl into .sim_internal, closes #42
…f .sim_bp_linelist
Will merge tomorrow, as these changes are needed to produce a reprex for an issue in another package. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Interface is not changed so I've reviewed this summarily.
Do we need to question the fact that snapshot tests have changed? Even if you confirm this change is expected and valid, please document it in the changelog.
During the review of this PR a diagram of the package architecture has been added to the design principles vignette. I've edited the original comment of this PR to include these changes. |
This PR addresses #42 by replacing
.sim_bp_linelist()
,.sim_clinical_linelist()
and.sim_contacts_tbl()
with.sim_internal()
.sim_linelist()
,sim_contacts()
, andsim_outbreak()
now all call.sim_internal()
.The
sim_utils.R
file has been renamed toutils.R
as the internal simulation functions have been removed.The function documentation has been updated, the design principles vignette now refers to
.sim_internal()
rather than.sim_bp_linelist()
, and snapshots for the regression tests have been updated.A diagram of the {simulist} package architecture and call stack from exported functions is added to the design principles vignette.