R/check_data.R

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

#' checks if data is permissible for a pollyvote object
#' 
#' internal check function
#'
#' @inheritParams add_data
#' 
#' @examples 
#' pv = create_pollyvote(perm_countries = "D")
#' data("election_result")
#' election_result = check_data(election_result, pv)
#' 
#' @return the checked data.
check_data = function(newdata, pv) {
  # check col names
  for(i in colnames(newdata)) {
    if(!(i %in% pv$perm_colnames)) {
      stop(paste0(i, " is not a permissible colum name for newdata.",
                  " It must be one of c('", 
                  paste0(pv$perm_colnames, collapse = "', '"), "')"))
    }
  }
  
  # check data in colums
  if("country" %in% colnames(newdata) & length(pv$perm_countries) > 0) 
    sapply(newdata$country, assert_choice, pv$perm_countries)
  if("source" %in% colnames(newdata) & length(pv$perm_sources) > 0)
    sapply(newdata$source, assert_choice, pv$perm_sources)
  if("source_type" %in% colnames(newdata) & length(pv$perm_source_types) > 0)
    sapply(newdata$source, assert_choice, pv$perm_source_types)
  if("election" %in% colnames(newdata) & length(pv$perm_elections) > 0) 
    sapply(newdata$election, assert_choice, pv$perm_elections)
  if("date" %in% colnames(newdata)) {
    stopifnot(all(newdata$date < pv$perm_date_latest))
    stopifnot(all(newdata$date > pv$perm_date_latest))
    # reformat to the right data structure
    newdata$date = as.POSIXct(format(newdata$date, format = "%Y-%m-%d", usetz = FALSE))
  }
  if("region" %in% colnames(newdata) & length(pv$perm_regions) > 0) 
    sapply(newdata$region, assert_choice, pv$perm_regions)
  if("region_type" %in% colnames(newdata) & length(pv$perm_region_types) > 0) 
    sapply(newdata$region, assert_choice, pv$perm_region_types)
  if("party" %in% colnames(newdata) & length(pv$perm_parties) > 0) 
    sapply(newdata$party, assert_choice, pv$perm_parties)
    newdata$party = as.factor(newdata$party)
  if("percent" %in% colnames(newdata)) 
    assert_numeric(newdata$percent, lower = 0, upper = 100)
  
  return(newdata)
}