Enhance probability_contain()
and remove {bpmodels} as package dependency
#103
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 thechain_sim()
code. The new functionality is:outbreak_time
argument. Thegeneration_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 renamedsimulate
to be consistent with other functions in the package that havesimulate
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}.