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

Enhance probability_contain() and remove {bpmodels} as package dependency #103

Merged
merged 11 commits into from
Oct 7, 2024

Conversation

joshwlambert
Copy link
Member

This PR removes {bpmodels} as a package dependency and uses a modified version of the bpmodels::chain_sim() function to maintain the same functionality (.chain_sim()).

@sbfnk is added as a copyright holder as the author of bpmodels::chain_sim() and @jamesmbaazam is added as package contributors as the maintainer of {bpmodels}.

The functionality of probability_contain() is enhanced, partially as these enhancements are straightforward developments from the previous version of the function, and to somewhat justify the porting of the chain_sim() code. The new functionality is:

  • The probability that an outbreak is contained within a given period of time can be calculated using the new outbreak_time argument. The generation_time argument is added to allow the branching process to use a generation time distribution to track the time between infections and the duration of the outbreak.

The stochastic argument has been renamed simulate to be consistent with other functions in the package that have simulate as an argument (e.g. proportion_transmission()).

The documentation of probability_contain() has been updated.

The design-principles.Rmd vignette has been updated to reflect the removal of {bpmodels}.

@joshwlambert joshwlambert added enhancement New feature or request pkg infrastructure General update tasks relating to the package and not functionality labels Sep 27, 2024
Copy link

This pull request:

  • Adds 0 new dependencies (direct and indirect)
  • Adds 0 new system dependencies
  • Removes 1 existing dependencies (direct and indirect)
  • Removes 1 existing system dependencies

(Note that results may be inacurrate if you branched from an outdated version of the target branch.)

@joshwlambert joshwlambert merged commit ab0ad51 into main Oct 7, 2024
9 checks passed
@joshwlambert joshwlambert deleted the rm-bpmodels branch October 7, 2024 10:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request pkg infrastructure General update tasks relating to the package and not functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants