Skip to content
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

Merged
merged 9 commits into from
Feb 15, 2024
Merged

Refactor simulation architecture #66

merged 9 commits into from
Feb 15, 2024

Conversation

joshwlambert
Copy link
Member

@joshwlambert joshwlambert commented Feb 12, 2024

This PR addresses #42 by replacing .sim_bp_linelist(), .sim_clinical_linelist() and .sim_contacts_tbl() with .sim_internal(). sim_linelist(), sim_contacts(), and sim_outbreak() now all call .sim_internal().

The sim_utils.R file has been renamed to utils.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.

@joshwlambert joshwlambert added the internal Updates that only change internal functions label Feb 12, 2024
@joshwlambert joshwlambert requested a review from Bisaloo February 12, 2024 10:23
@joshwlambert
Copy link
Member Author

Will merge tomorrow, as these changes are needed to produce a reprex for an issue in another package.

Copy link
Member

@Bisaloo Bisaloo left a 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.

@joshwlambert
Copy link
Member Author

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.

@joshwlambert joshwlambert merged commit de6a010 into main Feb 15, 2024
7 checks passed
@joshwlambert joshwlambert deleted the refactor_sim branch February 15, 2024 15:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal Updates that only change internal functions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants