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

Documentation for Bitset$sample is misleading #196

Open
giovannic opened this issue Apr 12, 2024 · 0 comments
Open

Documentation for Bitset$sample is misleading #196

giovannic opened this issue Apr 12, 2024 · 0 comments
Labels
good first issue Good for newcomers small We have estimated that the issue should be one of the quicker fixes (1 point)

Comments

@giovannic
Copy link
Member

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.

@giovannic giovannic added good first issue Good for newcomers small We have estimated that the issue should be one of the quicker fixes (1 point) labels Apr 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers small We have estimated that the issue should be one of the quicker fixes (1 point)
Projects
None yet
Development

No branches or pull requests

1 participant