Skip to content

Issue #547: update package description in README#563

Merged
nikosbosse merged 4 commits intodevelopfrom
readme-package-desc
Jan 5, 2024
Merged

Issue #547: update package description in README#563
nikosbosse merged 4 commits intodevelopfrom
readme-package-desc

Conversation

@sbfnk
Copy link
Copy Markdown
Contributor

@sbfnk sbfnk commented Jan 5, 2024


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

  • My PR is based on a package issue and I have explicitly linked it.
  • I have included the target issue or issues in the PR title as follows: issue-number: PR title
  • I have tested my changes locally.
  • I have added or updated unit tests where necessary.
  • I have updated the documentation if required.
  • I have built the package locally and run rebuilt docs using roxygen2.
  • My code follows the established coding standards and I have run lintr::lint_package() to check for style issues introduced by my changes.
  • I have added a news item linked to this PR.
  • I have reviewed CI checks for this PR and addressed them as far as I am able.

@codecov
Copy link
Copy Markdown

codecov bot commented Jan 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (52e2cb8) 84.55% compared to head (ee3120b) 85.14%.
Report is 17 commits behind head on develop.

❗ Current head ee3120b differs from pull request most recent head e5a4a77. Consider uploading reports for the commit e5a4a77 to get more accurate results

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.
📢 Have feedback on the report? Share it here.

@sbfnk sbfnk force-pushed the readme-package-desc branch from d1b9438 to a313ccc Compare January 5, 2024 15:22
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>

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made an alternative suggestion in ee3120b - what do you think?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

love it

Copy link
Copy Markdown
Collaborator

@nikosbosse nikosbosse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me - only thing I would add is the paper on transforming forecasts. Or do you think it should not be mentioned?

@sbfnk sbfnk force-pushed the readme-package-desc branch from ae82548 to ee3120b Compare January 5, 2024 15:52
Copy link
Copy Markdown
Contributor

@seabbs seabbs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this.

@nikosbosse nikosbosse merged commit 67163a4 into develop Jan 5, 2024
@nikosbosse nikosbosse deleted the readme-package-desc branch January 5, 2024 16:04
@sbfnk sbfnk mentioned this pull request Jan 5, 2024
@seabbs seabbs mentioned this pull request Jan 5, 2024
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants