mrc-ide / individual

R Package for individual based epidemiological models
https://mrc-ide.github.io/individual
Other
30 stars 16 forks source link

Documentation for Bitset$sample is misleading #196

Open giovannic opened 7 months ago

giovannic commented 7 months ago

First picked up on here

A rate can mean a lot of things, but in epi. it's most often interpreted as the number of events per unit time. Instead, a probability refers to the likelihood of an event happening to an individual.

At the very least we should document Bitset$sample to have a prob argument instead of a rate argument. But we should change the implementation variable names to make that less confusing for development.