Skip to content

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

Merged
merged 13 commits into from
Oct 3, 2023
Merged

workflow/options vignettes #458

merged 13 commits into from
Oct 3, 2023

Conversation

sbfnk
Copy link
Contributor

@sbfnk sbfnk commented Sep 27, 2023

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.

Copy link
Contributor

@seabbs seabbs left a 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

@sbfnk sbfnk requested a review from jamesmbaazam September 28, 2023 08:13
jamesmbaazam
jamesmbaazam previously approved these changes Sep 29, 2023
Copy link
Contributor

@jamesmbaazam jamesmbaazam left a 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.

@sbfnk
Copy link
Contributor Author

sbfnk commented Oct 3, 2023

Thanks, @jamesmbaazam for the suggestions! I've edited the corresponding .orig files and recompiled the vignettes (How to precompute package vignettes or pkgdown articles).

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.

Tricky as this would normally not be called by the user directly (instead, the user would use +). This could be reconsidered when switching to a more general observation model as discussed in #371

@sbfnk sbfnk merged commit 14718c0 into main Oct 3, 2023
@seabbs seabbs deleted the new-vignettes branch October 3, 2023 09:44
@jamesmbaazam
Copy link
Contributor

Thanks, @jamesmbaazam for the suggestions! I've edited the corresponding .orig files and recompiled the vignettes (How to precompute package vignettes or pkgdown articles).

Thanks for this. Now I know. I've never had to deal with this.

@seabbs
Copy link
Contributor

seabbs commented Oct 3, 2023

it should likely be added to the contributing guide if it isn't already (I think it isn't)

sbfnk added a commit that referenced this pull request May 3, 2024
* 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
sbfnk added a commit that referenced this pull request May 3, 2024
* 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants