Skip to content

Commit

Permalink
Merge pull request #965 from epiforecasts/update-readme-241
Browse files Browse the repository at this point in the history
Update README
  • Loading branch information
nikosbosse authored Oct 31, 2024
2 parents 950f411 + c06ff27 commit efb41af
Showing 1 changed file with 15 additions and 13 deletions.
28 changes: 15 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ version](https://drive.google.com/file/d/1URaMsXmHJ1twpLpMl1sl2HW4lPuUycoj/view?
of our [original](https://doi.org/10.48550/arXiv.2205.07090)
`scoringutils` paper.

Another good starting point are the vignettes on [Getting
started](https://epiforecasts.io/scoringutils/articles/scoringutils.html),
Another good starting point are the vignettes
<!-- vignettes on [Getting started](https://epiforecasts.io/scoringutils/articles/scoringutils.html), -->
[Details on the metrics
implemented](https://epiforecasts.io/scoringutils/articles/metric-details.html)
and [Scoring forecasts
Expand Down Expand Up @@ -67,17 +67,19 @@ remotes::install_github("epiforecasts/scoringutils", dependencies = TRUE)

### Forecast types

`scoringutils` currently supports scoring the following forecast
types: - `binary`: a probability for a binary (yes/no) outcome
variable. - `point`: a forecast for a continuous or discrete outcome
variable that is represented by a single number. - `quantile`: a
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. - `nominal`
categorical forecast with unordered outcome possibilities
(generalisation of binary forecasts to multiple outcomes)
`scoringutils` currently supports scoring the following forecast types:

- `binary`: a probability for a binary (yes/no) outcome variable.
- `point`: a forecast for a continuous or discrete outcome variable that
is represented by a single number.
- `quantile`: a 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.
- `nominal` categorical forecast with unordered outcome possibilities
(generalisation of binary forecasts to multiple outcomes)

### Input formats and input validation

Expand Down

0 comments on commit efb41af

Please sign in to comment.