R/check_input.R

In rgtmx: Manage GTmetrix Tests in R

#' @title Check variable inputs
#'
#' @description Internal function to check input variables
#'
#' @param input .
#' @param input_type .
#' @param input_validation .
#' @param min_value .
#' @param max_value .
#' @param max_length .
#' @param variable_name .
#' @param is_missing .
#'
#' @return nothing

check_input <- function(input, input_type, input_validation = NULL,
                         min_value = -Inf, max_value = Inf, max_length = 1L,
                         variable_name = NULL, is_missing = NULL) {


  if (!missing(is_missing)) {
    if (is_missing) {
      stop("Please supply ", variable_name, ". (is missing)")
    }
  }

  if (!missing(input_validation)) {
    if (!sum(input %in% input_validation == length(input))) {
      stop("Please supply correct ", variable_name, " value. (allowed values: ",
           paste0(input_validation, collapse = ", "), ")")
    }
  }

  if (is.null(input)) {
    stop("Please supply ", variable_name, ". (is.null)")
  } else if (is.na(input)) {
    stop("Please supply ", variable_name, ". (is.na)")
  } else if (input == "") {
    stop("Please supply ", variable_name, ". (is empty string)")
  } else if (length(input) > max_length) {
    stop("Too many values supplied for ", variable_name, ". (max_length is ",
         max_length, ")")
  }

  if (input_type == "character") {

    tryCatch(
      expr = {
        input <- as.character(input)
      },
      error = function(e) {
        stop("Could not coerce ", variable_name,
             " to the correct format. (is not ", input_type, " type)")
      },
      warning = function(w) {
        stop("Could not coerce ", variable_name,
             " to the correct format. (is not ", input_type, " type)")
      }
    )

  } else if (input_type == "numeric") {

    tryCatch(
      expr = {
        input <- as.numeric(input)
      },
      error = function(e) {
        stop("Could not coerce ", variable_name,
             " to the correct format. (is not ", input_type, " type)")
      },
      warning = function(w) {
        stop("Could not coerce ", variable_name,
             " to the correct format. (is not ", input_type, " type)")
      }
    )

    if (input < min_value) {
      stop("Please enter a ", variable_name,
           " higher than ", min_value, ". (is lower than min_value)")
    } else if (input > max_value) {
      stop("Please enter a ", variable_name,
           " lower than ", max_value, ". (is higher than min_value)")
    }

  } else if (input_type == "logical") {

    tryCatch(
      expr = {
        as.logical(input)
      },
      error = function(e) {
        stop("Could not coerce ", variable_name,
             " to the correct format. (is not ", input_type, " type)")
      },
      warning = function(w) {
        stop("Could not coerce ", variable_name,
             " to the correct format. (is not ", input_type, " type)")
      }
    )

  }


}