diff --git a/README.Rmd b/README.Rmd index ba111ebc..859d91a5 100644 --- a/README.Rmd +++ b/README.Rmd @@ -10,7 +10,7 @@ output: [![codecov](https://codecov.io/github/epiforecasts/scoringutils/branch/main/graph/badge.svg)](https://app.codecov.io/gh/epiforecasts/scoringutils) [![CRAN\_Release\_Badge](https://www.r-pkg.org/badges/version-ago/scoringutils)](https://CRAN.R-project.org/package=scoringutils) ![GitHub R package version](https://img.shields.io/github/r-package/v/epiforecasts/scoringutils) -[![metacran downloads](http://cranlogs.r-pkg.org/badges/grand-total/scoringutils)](https://cran.r-project.org/package=scoringutils) +[![metacrandownloads](http://cranlogs.r-pkg.org/badges/grand-total/scoringutils)](https://cran.r-project.org/package=scoringutils) diff --git a/README.md b/README.md index 038bd7ec..2cc62f36 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,7 @@ scoringutils: Utilities for Scoring and Assessing Predictions [![CRAN_Release_Badge](https://www.r-pkg.org/badges/version-ago/scoringutils)](https://CRAN.R-project.org/package=scoringutils) ![GitHub R package version](https://img.shields.io/github/r-package/v/epiforecasts/scoringutils) -[![metacran -downloads](http://cranlogs.r-pkg.org/badges/grand-total/scoringutils)](https://cran.r-project.org/package=scoringutils) +[![metacrandownloads](http://cranlogs.r-pkg.org/badges/grand-total/scoringutils)](https://cran.r-project.org/package=scoringutils) **Note**: [This @@ -77,21 +76,24 @@ probabilistic forecast for a continuous or discrete outcome variable, with the forecast distribution represented by a set of predictive quantiles. - `sample`: a probabilistic forecast for a continuous or discrete outcome variable, with the forecast represented by a finite set -of samples drawn from the predictive distribution. +of samples drawn from the predictive distribution. - `nominal` +categorical forecast with unordered outcome possibilities +(generalisation of binary forecasts to multiple outcomes) ### Input formats and input validation The expected input format is generally a `data.frame` (or similar) with -required columns `observed`, `predicted`, and `model` that holds the -forecasts and observed values. Exact requirements depend on the forecast -type. For more information, have a look at the +required columns `observed`, and `predicted` that holds the forecasts +and observed values. Exact requirements depend on the forecast type. For +more information, have a look at the [paper](https://drive.google.com/file/d/1URaMsXmHJ1twpLpMl1sl2HW4lPuUycoj/view?usp=drive_link), -call `?as_forecast()`, or have a look at the example data provided in -the package (`example_binary`, `example_point`, `example_quantile`, -`example_sample_continuous`, `example_sample_discrete`). +call `?as_forecast_binary`, `?as_forecast_quantile` etc., or have a look +at the example data provided in the package (`example_binary`, +`example_point`, `example_quantile`, `example_sample_continuous`, +`example_sample_discrete`, `example_nominal`). Before scoring, input data needs to be validated and transformed into a -forecast object using the function `as_forecast()`. +forecast object using one of the `as_forecast_()` functions. ``` r forecast_quantile <- example_quantile |> @@ -254,7 +256,9 @@ Health. ## Contributors + + All contributions to this project are gratefully acknowledged using the @@ -291,5 +295,7 @@ specification. Contributions of any kind are welcome! kathsherratt + +