Future of the current `scoringutils.Rmd` vignette

[nikosbosse]

The current scoringutils.Rmd vignette (which is also the Get started vignette on epiforecasts.io/scoringutils) is outdated. My intuition is we should just delete/replace it.

I see value in the following kinds of vignettes/docs (not exhaustive)

1. A quick start
2. A very comprehensive overview of everything
3. A gentle introduction that takes your hand and walks you through the basic things

1. is essentially what the current Readme.md achieves. 2. is what the updated paper takes care of. 3. doesn't currently exist, but could be @jhellewell14's vignette (#546).

Options:

1. we delete the current scoringutils.Rmd vignette and replace it with the updated paper which would then permanently become the new Get started vignette.
2. we delete the current scoringutils.Rmd vignette and replace it with the gentle introduction a. we do that now and commit to having a first version of that vignette ready for the next CRAN release b. we delete it without replacement for now. c. we first replace it with the manuscript and later replace it with the gentle introduction
3. we do something to the current scoringutils.Rmd vignette.

[seabbs]

I would favour 2a but its obviously more work. Happy to muck in.

[nikosbosse]

I would favour 2a but its obviously more work. Happy to muck in. Good for me! @jhellewell14, @seabbs would you be willing to take charge of this?

[seabbs]

yes

[nikosbosse]

@seabbs what's your current feeling re doing this before the next CRAN release? Alternative would be to delete the Vignette for now and refer to the paper.

[seabbs]

I think we should aim for A quick start and if that is just moving content from the readme and fleshing out that seems okay

[nikosbosse]

Are you still willing/have capacity to look into this or do we need to make changes?

[seabbs]

yes happy to do it - will aim for this weekend

[nikosbosse]

Thank you!