scoringutils icon indicating copy to clipboard operation
scoringutils copied to clipboard

Simplify "Getting Started" | Split into smaller chunks

Open jamesmbaazam opened this issue 2 years ago • 7 comments

I think the "Getting Started" vignette is well-written but quite long. May I suggest writing a simpler version of the current one and splitting the current one into smaller chunks, for example, preprocessing forecasts, scoring, and summarising?

jamesmbaazam avatar Jan 05 '24 10:01 jamesmbaazam

Would you want to draw a slightly more detailed outline of what you think should be in the Vignette? Also pinging @jhellewell

nikosbosse avatar Jan 05 '24 14:01 nikosbosse

I believe @jhellewell14 already drew up a nice first draft that we can work off. In my opinion, a Getting Started vignette should touch on the key functions in a package in a simple end-to-end example.

jamesmbaazam avatar Jan 08 '24 10:01 jamesmbaazam

That would be great, @jhellewell14 let us know if there is a draft that we can look at / whether there is anything useful we could do to help

nikosbosse avatar Jan 08 '24 13:01 nikosbosse

I've put a first draft of a gentle introduction vignette here, all feedback welcome! https://github.com/jhellewell14/scoringutils/blob/issue546/vignettes/gentle_intro.Rmd

jhellewell14 avatar Jan 10 '24 14:01 jhellewell14

I like it. Could maybe use some subtitles to break up the sections. Having rstanarm as a suggests is maybe not ideal but its also not the end of the world.

seabbs avatar Jan 11 '24 15:01 seabbs

Just for a note for the "Getting Started". I think Converting to quantile-based forecast section in Getting started should be moved to Articles or be mentioned in an early stage. Otherwise, someone tries to follow up the tutorial with their own dataset and he/she tries to clean it to be compatible with a quantile-based format by themselves. After all, finishing the tutorial, they will notice the converting functionality in scoringutils and their cleaning effort will be in vain, (which almost happened to me...).

toshiakiasakura avatar Feb 22 '24 09:02 toshiakiasakura

This doesn't seem absolutely critical for 2.0.0 so shall we shift to a later release - unless anyone else has some time to put into this?

seabbs avatar Mar 18 '24 10:03 seabbs