R/verify_targets.R

In jarad/FluSight: Utility functions for the CDC FluSight competition

#' Verify targets are correct
#'
#' The necessary targets depend on the challenge, so this will verify targets are correct
#' for all targets
#'
#' @param entry An entry data.frame
#' @param challenge one of "ilinet", "hospital" or "state_ili", indicating which
#'   challenge the submission is for
#' @return Invisibly returns TRUE if successful
#' @export
#' @keywords internal
#' @seealso \code{\link{verify_entry}}
#' @examples
#' verify_targets(minimal_entry)
verify_targets <- function(entry, challenge = "ilinet") {
  
  if (!(challenge %in% c("ilinet", "hospital", "state_ili"))) {
    stop("challenge must be one of ilinet, hospital, or state_ili")
  }
  
  names(entry) <- tolower(names(entry))
  
  # ILINet challenge
  if (challenge == "ilinet") {
    valid_targets <- unique(FluSight::minimal_entry$target)
  } else if (challenge == "hospital") {
    valid_targets <- unique(FluSight::full_entry_hosp$target)
  } else if (challenge == "state_ili") {
    valid_targets <- unique(FluSight::full_entry_state$target)
  } 
  
  entry_targets <- unique(entry$target)
  
  missing_targets <- setdiff(valid_targets, entry_targets)
  extra_targets   <- setdiff(entry_targets, valid_targets)

  if (length(missing_targets)>0)
    stop("Missing these targets: ", paste(missing_targets))

  if (length(extra_targets)>0)
    warning("These extra targets are ignored: ", paste(extra_targets))
  
  return(invisible(TRUE))
}