search

epinowcast / primarycensored

Primary event censored distributions in R and Stan.
https://primarycensored.epinowcast.org/
Other
7 stars 1 forks source link

Primary event times (p) definition within function call unclear from first look at the docs #107

Closed jcblemai closed 1 week ago

jcblemai commented 2 weeks ago

Describe the bug In the main documentation, here, we have the mention of an $f_p$ distribution that generates the primary event times. As this distribution is not explicitly shown or mentioned in the code snippet below, there is some confusion about how to set it put (and I ended up assuming the first arguments of rprimarycensoreddist was this $f_p$, but no, it was the delay distribution. I

To Reproduce Steps to reproduce the behavior:

  1. Go to the documentation, and try to match the described distribution to the function call below.

Expected behavior Either an explicit set of this distribution within the function call, or a comment that the default argument is uniform and that it is not shown there.

seabbs commented 2 weeks ago

Thanks for the this @jcblemai and hope you got home safely!

Any chance you would like to have a go at a PR to improve the clarity of this? No worries if not.

I think the fix is to directly the the primary event distributions as arguments in the code blocks rather than depend on the defaults?

seabbs commented 1 week ago

Closed by #122