R/check_list_of_lists.R

In oeli: Utilities for Developing Data Science Software

#' Check list of lists
#'
#' @description
#' These functions check whether the input is a list that contains list
#' elements.
#'
#' @inheritParams checkmate::check_list
#'
#' @return
#' Same as documented in \code{\link[checkmate]{check_list}}.
#'
#' @keywords validation
#' @family list helpers
#' @export
#'
#' @examples
#' L <- list(list(1), list(2), 3)
#' check_list_of_lists(L)
#' test_list_of_lists(L)
#' \dontrun{
#' assert_list_of_lists(L)
#' }

check_list_of_lists <- function(x, len = NULL) {
  res <- checkmate::check_list(x, len = len)
  if (!isTRUE(res)) {
    return(res)
  }
  for (i in seq_along(x)) {
    res <- checkmate::check_list(x[[i]], len = len)
    if (!isTRUE(res)) {
      return(paste("Check for element", i, "failed:", res))
    }
  }
  return(TRUE)
}

#' @rdname check_list_of_lists
#' @inheritParams checkmate::assert_list
#' @export

assert_list_of_lists <- checkmate::makeAssertionFunction(
  check_list_of_lists
)

#' @rdname check_list_of_lists
#' @inheritParams checkmate::assert_list
#' @export

test_list_of_lists <- checkmate::makeTestFunction(
  check_list_of_lists
)