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

Describe epidemics design decisions #188

Merged
merged 6 commits into from Mar 11, 2024
Merged

Describe epidemics design decisions #188

merged 6 commits into from Mar 11, 2024

Conversation

pratikunterwegs
Copy link
Member

@pratikunterwegs pratikunterwegs commented Mar 4, 2024

This PR adds a design vignette that aims to fix #69. This vignette refers to changes incoming in #176.

@pratikunterwegs pratikunterwegs marked this pull request as ready for review March 8, 2024 11:41
Copy link
Member

@joshwlambert joshwlambert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fantastic work @pratikunterwegs. Exactly what is required for a complex package to explain style and substance. I've left a few minor comments, but all good to get this merged when you're ready.

vignettes/design-principles.Rmd Show resolved Hide resolved
vignettes/design-principles.Rmd Outdated Show resolved Hide resolved

**Fig. 1:** _epidemics_ is designed to allow easy combination of composable elements with a model structure taken from a library of published models, with sensible default parameters, to allow public health practitioners to conveniently model epidemic scenarios and the efficacy of response strategies.

<img src="../man/figures/epidemics_architecture.png" width="700" />
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will depend on screen size, but the text in this figure is relatively hard to read for me. Could make the whole figure a bit larger or edit the figure to increase font size.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. I've increased the size a bit, but it doesn't seem to be helping. I'll leave this as it is for now, and perhaps consider splitting it up in a future version.

vignettes/design-principles.Rmd Outdated Show resolved Hide resolved
vignettes/design-principles.Rmd Outdated Show resolved Hide resolved
vignettes/design-principles.Rmd Outdated Show resolved Hide resolved
pratikunterwegs and others added 3 commits March 11, 2024 09:31
Co-authored-by: Joshua Lambert <joshua.lambert@lshtm.ac.uk>
Co-authored-by: Joshua Lambert <joshua.lambert@lshtm.ac.uk>
@pratikunterwegs pratikunterwegs merged commit cfdb69d into main Mar 11, 2024
10 checks passed
@pratikunterwegs pratikunterwegs deleted the design branch March 11, 2024 11:13
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.

Add a package design vignette
2 participants