|
1 | 1 | --- |
2 | | -title: 'scoringutils: Utilities for Scoring and Assessing Predictions' |
3 | 2 | output: |
4 | 3 | github_document: |
5 | 4 | toc: false |
6 | 5 | --- |
7 | 6 |
|
| 7 | +# scoringutils <a href="https://epiforecasts.io/"><img src="man/figures/logo.png" align="right" height="175" alt="epiforecasts.io website" /></a> |
| 8 | + |
8 | 9 | <!-- badges: start --> |
9 | 10 | [](https://github.com/epiforecasts/scoringutils/actions/workflows/R-CMD-check.yaml) |
10 | 11 | [](https://app.codecov.io/gh/epiforecasts/scoringutils) |
@@ -34,24 +35,26 @@ devel <- length(unclass(package_version(version))[[1]]) > 3 |
34 | 35 | ```{r note_dev, results = 'asis', echo = FALSE} |
35 | 36 | if (devel) { |
36 | 37 | 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*]", |
40 | 41 | "(https://epiforecasts.io/scoringutils/).", |
41 | 42 | sep = "" |
42 | 43 | ) |
43 | 44 | } else { |
44 | 45 | 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*]", |
48 | 49 | "(https://epiforecasts.io/scoringutils/dev/).", |
49 | 50 | sep = "" |
50 | 51 | ) |
51 | 52 | } |
52 | 53 | cat("\n\n") |
53 | 54 | ``` |
54 | 55 |
|
| 56 | +## Utilities for Scoring and Assessing Predictions |
| 57 | + |
55 | 58 | 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. |
56 | 59 |
|
57 | 60 | 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. |
|
0 commit comments