R/check_valid_structure.R

In lsasim: Functions to Facilitate the Simulation of Large Scale Assessment Data

#' @title Check if List is Valid
#' @description Checks if a list has a proper structure to be transformed into a hierarchical structure
#' @param n list
#' @return Error if the structure is improper. Otherwise, there's no output.
#' @seealso check_condition
check_valid_structure <- function(n)
{
    for (l in seq(length(n) - 1)) {
    check_condition(
      length(n[[l + 1]]) != sum(n[[l]]),
      paste0(
        "Invalid cluster structure on level ", l + 1,
        ".\nThat level should have ", sum(n[[l]]),
        " elements, but it has ", length(n[[l + 1]]),
        "\nCheck the length of your object at that level, ",
        "maybe it should be a scalar.",
        "\nPlease refer to the documentation if necessary."
      )
    )
  }
}