Error when negative infectious period is sampled #142
Merged
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 addresses #141 by adding a check that the sampled infectious period is positive and if not then erroring. A new internal function is added,
.sample_infect_period()
, which samples from the user-supplied infectious period and checks if the value is positive. This is a new function to prevent the cyclomatic complexity of.sim_network_bp()
from exceeding 15.A new unit test is added to ensure the
stop()
in.sample_infect_period()
is correctly triggered when called by.sim_network_bp()
.The
infect_period
argument documentation is updated to document that only positive values are valid.