README

[sabahzero]

• Be explicit that installation occurs in R script and not command line (this seems intuitive, but doesn't hurt to state)
• Be more descriptive with purpose and function of R package directly, rather than relying on the user to click on the vignette (which does a good job of explaining functions themselves, but isn't entirely descriptive itself). For example, provide a few of the package uses directly.
• License? Credits? I know we did an overview on how to approach a README (Mar 3, 2020) that Ginger facilitating, and there was a GoogleDoc breakdown

[sabahzero]

It looks like there's a few different vignettes in the 'docs' folder, but in the README only one is listed. I would be explicit in the README on what each of these do, and why you're focusing on the one you have hyperlinked in the README (or otherwise briefly describe them all)

[sabahzero]

Include notes about additionally installing the following libraries in R (RE Janet's comments)

library(outbreakinfo) library(ggplot2) library(dplyr)

[sabahzero]

Looking at the vignettes, they all seem good to me but I think it would be even better for the user if you could walk them through a specific case and have an example of how each argument is executed. I can set aside 3-4 hours to help with this over the weekend, if you want.

[sabahzero]

Have you considered integrating gganimate as part of these? It may be a bit late now, but could be especially good for time progressions. This definitely needs to be updated, but the 'R resources' section may also be helpful: https://sabahzero.github.io/dataviz/resources