epiforecasts / scoringutils

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

How should we document methods that have different arguments than the default method? #793

Open nikosbosse opened 4 months ago

nikosbosse commented 4 months ago

In #790 @seabbs introduced the functions as_point() and as_quantile() which transform a forecast object into an object of class forecast_point() and forecast_quantile(), respectively.

For other methods (e.g. score() or is_forecast()) we always lumped all methods into one doc by using @rdname generic_function. This was fine, as all methods had the same arguments.

In this case, the methods have different arguments, depending on the class of the input.

Should all methods appear in one manual page, or should they appear in different ones?

I.e. should we have something like this

image

Or something like this

image

and a separate

image
seabbs commented 3 months ago

IMO they should appear in different ones. In your first example all the args for all the methods get lumped together in a very confusing way