Issue #547: update package description in README #563
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #563 +/- ##
===========================================
+ Coverage 84.55% 85.14% +0.59%
===========================================
Files 21 21
Lines 1722 1710 -12
===========================================
Hits 1456 1456
+ Misses 266 254 -12 ☔ View full report in Codecov by Sentry. |
sbfnk
force-pushed
the
readme-package-desc
branch
from
d1b9438 to
a313ccc
Compare
nikosbosse
reviewed
Jan 5, 2024
| For a detailed description of the package, its rationale and design, usage examples and how it relates to other packages in the R ecosystem, please see the corresponding paper: | ||
|
|
||
| > Nikos I. Bosse, Hugo Gruson, Anne Cori, Edwin van Leeuwen, Sebastian Funk and Sam Abbott (2022). _`Evaluating Forecasts with scoringutils in R`_. arXiv:2205.07090 <https://doi.org/10.48550/arXiv.2205.07090> | ||
|
|
There was a problem hiding this comment.
Suggested change
| As well as the paper [Scoring epidemiological forecasts on transformed scales](https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1011393). |
There was a problem hiding this comment.
Made an alternative suggestion in ee3120b - what do you think?
nikosbosse
reviewed
Jan 5, 2024
sbfnk
force-pushed
the
readme-package-desc
branch
from
ae82548 to
ee3120b
Compare
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR closes #547.
It explicitly cites the preprint and adds a "Package overview" section header.
Seems to small a change for a news item.
Checklist
lintr::lint_package()to check for style issues introduced by my changes.