R/errors.R

In signaux-faibles/MLsegmentr: Model evaluation on data segments

#' Assert predictions frame
#'
#' Asserts that predictions have the expected format for an Assesser parameter
#'
#' @param predictions `data.frame` \cr Decorated prediction frame
assert_predictions <- function(predictions){
  assertthat::assert_that(is.data.frame(predictions))
  assertthat::assert_that(".id" %in% names(predictions))
  assertthat::assert_that("model" %in% names(predictions))
  assertthat::assert_that("prediction" %in% names(predictions))
  assertthat::assert_that(is.numeric(predictions$prediction))
  assertthat::assert_that(all(!is.na(predictions$.id)))
  assertthat::assert_that(all(!is.na(predictions$model)))
}

#' Assert segment frame
#'
#' Asserts that segments have the expected format for an Assesser parameter
#'
#' @param segments `data.frame` Decorated segment frame
assert_segments <- function(segments){
  assertthat::assert_that(is.data.frame(segments))
  assertthat::assert_that(".id" %in% names(segments))
  assertthat::assert_that("segment" %in% names(segments))
  assertthat::assert_that(is.factor(segments$segment))
  assertthat::assert_that(all(!is.na(segments$.id)))
  assertthat::assert_that(all(!is.na(segments$segment)))
}

#' Assert target frame
#'
#' Asserts that targets have the expected format for an Assesser parameter
#'
#' @param targets `data.frame` \cr Decorated target frame
#'
assert_target <- function(targets){
  assertthat::assert_that(is.data.frame(targets))
  assertthat::assert_that(".id" %in% names(targets))
  assertthat::assert_that("target" %in% names(targets))
  assertthat::assert_that(all(!is.na(targets$.id)))
  assertthat::assert_that(all(!is.na(targets$target)))
}