Skip to content

Commit cbcb7be

Browse files
authored
Merge branch 'main' into multivariate
2 parents b61f72f + 34af8e1 commit cbcb7be

File tree

3 files changed

+19
-18
lines changed

3 files changed

+19
-18
lines changed

README.Rmd

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
title: 'scoringutils: Utilities for Scoring and Assessing Predictions'
32
output:
43
github_document:
54
toc: false
65
---
76

7+
# scoringutils <a href="https://epiforecasts.io/"><img src="man/figures/logo.png" align="right" height="175" alt="epiforecasts.io website" /></a>
8+
89
<!-- badges: start -->
910
[![R-CMD-check](https://github.com/epiforecasts/scoringutils/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/epiforecasts/scoringutils/actions/workflows/R-CMD-check.yaml)
1011
[![codecov](https://codecov.io/github/epiforecasts/scoringutils/branch/main/graph/badge.svg)](https://app.codecov.io/gh/epiforecasts/scoringutils)
@@ -34,24 +35,26 @@ devel <- length(unclass(package_version(version))[[1]]) > 3
3435
```{r note_dev, results = 'asis', echo = FALSE}
3536
if (devel) {
3637
cat(
37-
"**Note**: ",
38-
"[This documentation](https://epiforecasts.io/scoringutils/dev/) refers to the development version of `scoringutils`. ",
39-
"You can also view the [documentation of the stable version]",
38+
"***Note***: ",
39+
"[*This documentation*](https://epiforecasts.io/scoringutils/dev/) *refers to the development version of `scoringutils`.* ",
40+
"*You can also view the* [*documentation of the stable version*]",
4041
"(https://epiforecasts.io/scoringutils/).",
4142
sep = ""
4243
)
4344
} else {
4445
cat(
45-
"**Note**: ",
46-
"[This documentation](https://epiforecasts.io/scoringutils/) refers to the stable version of `scoringutils`. ",
47-
"You can also view the [documentation of the development version]",
46+
"***Note***: ",
47+
"[*This documentation*](https://epiforecasts.io/scoringutils/) *refers to the stable version of `scoringutils`.* ",
48+
"*You can also view the* [*documentation of the development version*]",
4849
"(https://epiforecasts.io/scoringutils/dev/).",
4950
sep = ""
5051
)
5152
}
5253
cat("\n\n")
5354
```
5455

56+
## Utilities for Scoring and Assessing Predictions
57+
5558
The `scoringutils` package facilitates the process of evaluating forecasts in R, using a convenient and flexible `data.table`-based framework. It provides broad functionality to check the input data and diagnose issues, to visualise forecasts and missing data, to transform data before scoring, to handle missing forecasts, to aggregate scores, and to visualise the results of the evaluation. The package is easily extendable, meaning that users can supply their own scoring rules or extend existing classes to handle new types of forecasts.
5659

5760
The package underwent a major re-write. The most comprehensive documentation for the updated package is the [revised version](https://drive.google.com/file/d/1URaMsXmHJ1twpLpMl1sl2HW4lPuUycoj/view?usp=drive_link) of our [original](https://doi.org/10.48550/arXiv.2205.07090) `scoringutils` paper.

README.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
scoringutils: Utilities for Scoring and Assessing Predictions
2-
================
1+
2+
# scoringutils <a href="https://epiforecasts.io/"><img src="man/figures/logo.png" align="right" height="175" alt="epiforecasts.io website" /></a>
33

44
<!-- badges: start -->
55

@@ -11,11 +11,13 @@ version](https://img.shields.io/github/r-package/v/epiforecasts/scoringutils)
1111
[![metacrandownloads](http://cranlogs.r-pkg.org/badges/grand-total/scoringutils)](https://cran.r-project.org/package=scoringutils)
1212
<!-- badges: end -->
1313

14-
**Note**: [This
15-
documentation](https://epiforecasts.io/scoringutils/dev/) refers to the
16-
development version of `scoringutils`. You can also view the
17-
[documentation of the stable
18-
version](https://epiforecasts.io/scoringutils/).
14+
***Note***: [*This
15+
documentation*](https://epiforecasts.io/scoringutils/dev/) *refers to
16+
the development version of `scoringutils`.* *You can also view the*
17+
[*documentation of the stable
18+
version*](https://epiforecasts.io/scoringutils/).
19+
20+
## Utilities for Scoring and Assessing Predictions
1921

2022
The `scoringutils` package facilitates the process of evaluating
2123
forecasts in R, using a convenient and flexible `data.table`-based
@@ -258,9 +260,7 @@ Health.
258260
## Contributors
259261

260262
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
261-
262263
<!-- prettier-ignore-start -->
263-
264264
<!-- markdownlint-disable -->
265265

266266
All contributions to this project are gratefully acknowledged using the
@@ -304,7 +304,5 @@ any kind are welcome!
304304
<a href="https://github.com/epiforecasts/scoringutils/issues?q=is%3Aissue+commenter%3ATimTaylor">TimTaylor</a>
305305

306306
<!-- markdownlint-enable -->
307-
308307
<!-- prettier-ignore-end -->
309-
310308
<!-- ALL-CONTRIBUTORS-LIST:END -->

man/figures/logo.png

-930 KB
Loading

0 commit comments

Comments
 (0)