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

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

Closed
jcblemai opened this issue Sep 24, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@jcblemai
Copy link

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
Copy link
Contributor

seabbs commented Sep 27, 2024

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 seabbs added the documentation Improvements or additions to documentation label Sep 30, 2024
@seabbs seabbs self-assigned this Oct 4, 2024
@seabbs
Copy link
Contributor

seabbs commented Oct 4, 2024

Closed by #122

@seabbs seabbs closed this as completed Oct 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants