CDCgov / wastewater-informed-covid-forecasting

Wastewater-informed COVID-19 forecasting models submitted to the COVID-19 Forecast Hub
https://cdcgov.github.io/wastewater-informed-covid-forecasting/
Apache License 2.0
43 stars 7 forks source link

Identify functions in wweval that should have examples and don't currently #48

Open kaitejohnson opened 3 months ago

kaitejohnson commented 3 months ago

Problem

Package functions are all missing examples

Requirements

Context

From @seabbs The general rule of thumb here is if it is exported then it should have an example. I generally use saved example runs to short cut long examples (i.e. https://package.epinowcast.org/dev/reference/enw_add_latest_obs_to_nowcast.html) but could also be better options as its a bit of a pain to make sure these stay in sync.

If we don't think it needs an example I would say that means its time to make it internal