epiverse-trace / simulist

An R package for simulating line lists
https://epiverse-trace.github.io/simulist/
Other
5 stars 1 forks source link

Error when negative infectious period is sampled #142

Closed joshwlambert closed 4 months ago

joshwlambert commented 4 months ago

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.