R/error_calc.R

In pollyvote/pollyvoter: Aggregate Components, Calculate Forecasts and Determine Errors for Election Results.

#' calculate the prediction error of a pollyvote prediction.
#' 
#' calculate the prediction error of a pollyvote prediction.
#'
#' @param object [\code{pollyvote(1)}] \cr
#'   pollyvote object to get the error calculation from.
#' @param method [\code{character(1)}] \cr
#'   method name of the error calculation function of \code{object} to use.
#' @param ... additional arguments to the error calculation function.
#' 
#' @examples 
#' pv = create_pollyvote(perm_countries = "D")
#' data("polls_individual")
#' pv = add_data(pv, newdata = polls_individual, country = "D", region = "national", 
#'               source_type = "poll", election = "BTW")
#' data("election_result")
#' pv = add_election_result(pv, "BTW 2013", election_result, date = "2013-09-22")
#' error_calc_pred <- error_calc(pv, "prediction_election", 
#'                               prediction = "pollyvote", election = "BTW 2013")             
#' 
#' @return a data frame containing the result of the error calculation
#' @family predict
#'
#' @export
error_calc = function(object, method, ...) {
  UseMethod("error_calc")
}

#' calculate the prediction error of a pollyvote prediction.
#' 
#' calculate the prediction error of a pollyvote prediction.
#'
#' @inheritParams error_calc
#' 
#' @examples
#' pv = create_pollyvote(perm_countries = "D")
#' data("polls_individual")
#' pv = add_data(pv, newdata = polls_individual, country = "D", region = "national", 
#'               source_type = "poll", election = "BTW")
#' data("election_result")
#' pv = add_election_result(pv, "BTW 2013", election_result, date = "2013-09-22")
#' error_calc_pred <- error_calc(pv, "prediction_election", 
#'                               prediction = "pollyvote", election = "BTW 2013")   
#' 
#' @return the prediction
#' @family predict
#'
#' @export
error_calc.pollyvote = function(object, method, ...) {
  assert_class(object, "pollyvote")
  return(object$error_calc[[method]](object, ...))
}