search

epiforecasts / scoringutils

Utilities for Scoring and Assessing Predictions
https://epiforecasts.io/scoringutils/
Other
48 stars 21 forks source link

Split out as_forecast documentation #951

Closed seabbs closed 3 weeks ago

seabbs commented 4 weeks ago

Currently all as_forecast_<type> share a single doc file. There may be some benefits to this but it makes extending hard and finding the precise details you need for a given method a bit tiring.

I also note the current docs refer to as_forecast extensively which no longer exists. Pruning this out seems like a good time to split the docs. If we like a central place to organise (to be clear I don't) this could take the form of a vignette.

nikosbosse commented 4 weeks ago

Currently all asforecast share a single doc file.

They all have a common file - but in addition to that, every function has their own file as well. I thought it would be helpful to pool info that's relevant to all forecast types in a single place. But you're right to point out that the current manual page is not that. I'll rework it.

Note that if you call ?as_forecast you actually land on the general manual page. So the function doesn't exist, but the page does

nikosbosse commented 3 weeks ago

ok did this in #955 which, as always, took longer than expected 🥲. The reason I did it is because things in the docs where out-of-date already. I think this speaks to your theory that having a central thing to maintain in addition to info where you need it is difficult.

I tried to stick to "the info is where you need it". I do like the idea of having an overview somewhere that tells you what you have available. But I think it needs to be something that's automatically populated, otherwise stuff will be out of date again very soon.

seabbs commented 3 weeks ago

Definitely agree on the auto populate idea