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

Improve documentation of nsim_obs and obs_prob in likelihood() #231

Closed
jamesmbaazam opened this issue Mar 21, 2024 · 0 comments · Fixed by #233
Closed

Improve documentation of nsim_obs and obs_prob in likelihood() #231

jamesmbaazam opened this issue Mar 21, 2024 · 0 comments · Fixed by #233

Comments

@jamesmbaazam
Copy link
Member

jamesmbaazam commented Mar 21, 2024

obs_prob currently says "Observation probability (assumed constant)". It could be improved to add examples and their interpretation, for example, "Observation probability. A value between 0 and 1. Any value below 1 implies imperfect observation and nsim_obs will be required. In the simulation, the observation process is assumed to be constant throughout the epidemic."

nsim_obs currently says "Number of simulations if the log-likelihood/likelihood is to be approximated for imperfect observation" but can be improved to say "Number of simulations if the log-likelihood/likelihood is to be approximated for imperfect observation, that is if obs_prob is below 1."

This way, it links the two arguments and helps to partly address #125 by clarifying which arguments are required and when.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant