-
Notifications
You must be signed in to change notification settings - Fork 37
workflow/options vignettes #458
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice stuff. Just a quick skim
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, Seb. I think these vignettes nicely highlight the various available models, and how to set up and run the models. The vignettes will be useful to most users.
I wonder if dist_spec_plus()
would benefit from taking an optional label
argument for the two distributions and passed on to the printing method for identifying the corresponding delays.
Thanks, @jamesmbaazam for the suggestions! I've edited the corresponding
Tricky as this would normally not be called by the user directly (instead, the user would use |
Thanks for this. Now I know. I've never had to deal with this. |
it should likely be added to the contributing guide if it isn't already (I think it isn't) |
* new vignettes * precompile workflow * set up for workflow * compiled vignettes * add news item * consistent italicisation of EpiNow2 * consistent () for functions * split out epinow() vignette * recompile * update pkdown menu * update news * recompile
* new vignettes * precompile workflow * set up for workflow * compiled vignettes * add news item * consistent italicisation of EpiNow2 * consistent () for functions * split out epinow() vignette * recompile * update pkdown menu * update news * recompile
Adds two vignettes, one on the general workflow for working with the package (which could be potentially expanded with more examples showing how the different models can feed into each other) and one to illustrate the various options for running
estimate_infections
in preparation from moving them out of the examples to address #430.Vignettes are precompiled so as to not require re-rendering all the time in GitHub actions.