get_target_type: Get type of the target true values of a forecast

View source: R/utils.R

get_target_typeR Documentation

Get type of the target true values of a forecast

Description

Internal helper function to get the type of the target true values of a forecast. That is inferred based on the which columns are present in the data.

Usage

get_target_type(data)

Arguments

data

A data.frame or data.table with the predictions and observations. For scoring using score(), the following columns need to be present:

  • true_value - the true observed values

  • prediction - predictions or predictive samples for one true value. (You only don't need to provide a prediction column if you want to score quantile forecasts in a wide range format.)

For scoring integer and continuous forecasts a sample column is needed:

  • sample - an index to identify the predictive samples in the prediction column generated by one model for one true value. Only necessary for continuous and integer forecasts, not for binary predictions.

For scoring predictions in a quantile-format forecast you should provide a column called quantile:

  • quantile: quantile to which the prediction corresponds

In addition a model column is suggested and if not present this will be flagged and added to the input data with all forecasts assigned as an "unspecified model").

You can check the format of your data using check_forecasts() and there are examples for each format (example_quantile, example_continuous, example_integer, and example_binary).

Value

Character vector of length one with either "binary", "integer", or "continuous"


scoringutils documentation built on Feb. 16, 2023, 7:30 p.m.