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

Clarify documentation for passing uncertainty from estimate_truncation to estimate_infections #367

Closed
seabbs opened this issue Feb 8, 2023 · 3 comments · Fixed by #644
Closed
Assignees
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@seabbs
Copy link
Contributor

seabbs commented Feb 8, 2023

See #365 for a user question highlighting the current issues and explanations of the current functionality. Ideally, we would improve areas of the documentation to make the various options clearer. This likely needs to happen both in the function examples and also with an explicit vignette walking through some of the more commonly used workflows we support.

@seabbs seabbs added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Feb 8, 2023
@sbfnk sbfnk mentioned this issue Jul 18, 2023
18 tasks
@jamesmbaazam
Copy link
Contributor

This issue has been partly addressed in the "truncation" section of the workflow vignette introduced in #458 (https://epiforecasts.io/EpiNow2/dev/articles/estimate_infections_workflow.html#truncation). However, reading it from the user perspective, I think, where it says "...which returns, amongst others, posterior estimates of the truncation distribution", we can explicitly say which output from estimate_truncation() is relevant here. In this case, it's dist.

We can also clarify in the documentation of the truncation argument of estimate_infection() and estimate_secondary() that it can be supplied as the dist output of estimate_truncation() and possibly link the relevant section in the workflow vignette.

@jamesmbaazam jamesmbaazam self-assigned this Mar 11, 2024
@sbfnk
Copy link
Contributor

sbfnk commented Apr 30, 2024

@jamesmbaazam do you think there is anything else we should do here for the upcoming release?

@jamesmbaazam
Copy link
Contributor

I'm cleaning up a few docs here and there to see if it clarifies this. PR incoming soon.

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 help wanted Extra attention is needed
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants