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

Getting started vignette #15

Closed
seabbs opened this issue Sep 2, 2024 · 2 comments · Fixed by #22
Closed

Getting started vignette #15

seabbs opened this issue Sep 2, 2024 · 2 comments · Fixed by #22
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@seabbs
Copy link
Contributor

seabbs commented Sep 2, 2024

A getting started vignette giving a quick introduction to the package R functions (and pointing at the stan functions).

I think it makes sense to replicate the maths we use in the help files here along with a small simulation comparison (i.e simulate from R function) with an without secondary censoring, show that without secondary censoring we get the cdf we get via integration, similarly show that for censoring we recover the same pmf.

If we think its useful we can use ggplot2 here but the built in plotting for ecdf (and friends) might be all we need

We should make sure to link out to our recent work on best practices and approaches to estimate delay distributions

@seabbs seabbs added enhancement New feature or request documentation Improvements or additions to documentation labels Sep 2, 2024
@seabbs
Copy link
Contributor Author

seabbs commented Sep 2, 2024

Note the package already contains a skeleton ready for this content

@seabbs seabbs self-assigned this Sep 2, 2024
@seabbs
Copy link
Contributor Author

seabbs commented Sep 3, 2024

Work is happening on this in issue15

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 enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant