search

CDCgov / cfa-gam-rt

R package for real-time Rt estimation with penalized splines
https://cdcgov.github.io/cfa-gam-rt/
Apache License 2.0
13 stars 1 forks source link

Getting started vignette #44

Open zsusswein opened 1 month ago

zsusswein commented 1 month ago

Both as a full vignette and perhaps building out the how-to in the Readme. If expanding the readme, consider moving the a Rmd readme that renders in GHA.

seabbs commented 1 month ago

I used to really like how tos in the README but multiple devs I have worked with have pushed to keep it very sparse and signposted and to have the code getting started be in a specific place

zsusswein commented 1 month ago

I'm surprised to hear that. R culture is pretty vignette-oriented. But see e.g., ripgrep, ruff, or duckdb. I'd think a lightweight readme to help potential uses identify whether reading the vignette would be worth it is a good idea?

seabbs commented 1 month ago

I'm not disagreeing it isn't something people do I am just pointing out a counter view which I have seen a lot recently in epi silos. I think both are valid choices.

A reason to not do it is if you have any figures in your README that are code generated and if you are planning to run something like an all contributors bot (as we do in say epinowcast). The combination of those two things would end up bloating the size of the package as the bot rerenders the README all the time.

SamuelBrand1 commented 4 days ago

Hey @zsusswein This project looks super interesting.

I'd love to see a full featured getting started vignette; or a simpler one and a more "in the weeds" example. It would help as an entry point for people having a glance (i.e. me).

zsusswein commented 4 days ago

I'm working on it for the v0.2.0 release! I'm hoping to have that out this week.

Or in other words, ask and you shall receive...