Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Future of the current scoringutils.Rmd vignette #759

Open
nikosbosse opened this issue Mar 27, 2024 · 3 comments
Open

Future of the current scoringutils.Rmd vignette #759

nikosbosse opened this issue Mar 27, 2024 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation question Further information is requested

Comments

@nikosbosse
Copy link
Contributor

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.
@nikosbosse nikosbosse added documentation Improvements or additions to documentation question Further information is requested labels Mar 27, 2024
@nikosbosse nikosbosse added this to the scoringutils-2.0 milestone Mar 27, 2024
@seabbs
Copy link
Contributor

seabbs commented Mar 28, 2024

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

@nikosbosse
Copy link
Contributor Author

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
Copy link
Contributor

seabbs commented Apr 3, 2024

yes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation question Further information is requested
Projects
Status: No status
Development

No branches or pull requests

2 participants