R/check_data_format.R

In intervalpsych: Analyzing Interval Data in Psychometrics

# helper function: run checks on simplex----------------------------------------
#' @title Check if data is a valid simplex
#'
#' @description Check if data is a valid simplex
#'
#' @param simplex A numeric vector that is a 2-simplex (3 elements that sum to 1)
#' or a dataframe where each of the rows is a 2-simplex
#'
#' @noRd
#'
check_simplex <- function(simplex) {
  # is numeric
  if (is.numeric(simplex) == FALSE) {
    stop("Error: vector must be numeric!")
  }
  # has length 3
  if (length(simplex) != 3) {
    stop("Error: (row-)vector must have exactly 3 elements!")
  }
  # check unit scale
  if (any(simplex < 0) || any(simplex > 1)) {
    stop("Error: (row-)vector must be in the unit scale!")
  }
  # check that all elements sum to one, round the sum to prevent numerical issues
  if (round(sum(simplex), 6) != 1) {
    stop("Error: (row-)vector must sum to 1!")
  }
  # all elements are non-zero and sums to one
  if (any(simplex == 0)) {
    stop(
      "Error: None of the elements in the (row-)vector must be exactly 0! Please apply padding first!"
    )
  }
}


# helper function: run checks on simplex----------------------------------------
#' @title Check if data is a valid bivariate normal vector
#'
#' @description Check if data is a valid bivariate normal vector
#'
#' @param bvn A numeric vector that is a bivariate normal vector (2 elements) or
#' a dataframe where each of the rows is a bivariate normal vector
#'
#' @noRd
#'
check_bvn <- function(bvn) {
  # is numeric
  if (!is.numeric(bvn)) {
    stop("Error: vector must be numeric!")
  }
  # has length 2
  if (length(bvn) != 2) {
    stop("Error: (row-)vector must have exactly 2 elements!")
  }
}


# helper function: check interval bounds data ----------------------------------
#' @title Check if data is a valid interval bounds
#'
#' @description Check if data is a valid interval bounds
#'
#' @param raw_data A numeric vector that is a interval bounds (2 elements) or
#' a dataframe where each of the rows is a interval bounds
#' @param min The minimum of the original response scale
#' @param max The maximum of the original response scale
#'
#' @noRd
#'
check_interval_bounds <- function(raw_data, min = NULL, max = NULL) {
  # check numeric
  if (!is.numeric(raw_data)) {
    stop("Error: Input must be a numeric vector!")
  }
  # compute min
  if (is.null(min)) {
    stop("Please specify the minimum of the original response scale.",
         min)
  }
  # compute max
  if (is.null(max)) {
    stop("Please specify the maximum of the original response scale.",
         max)
  }
  # check min is smaller than max
  if (min >= max) {
    stop("Minimum must be smaller than Maximum!")
  }

  l <- length(raw_data)
  # check length
  if (l != 2) {
    stop("Interval bounds data must have 2 values per response!")
  }
}