R/validate_ratio.R

In iAM-AMR/sawmill: Process Queries from the CEDAR Database

#' @title
#'   Validate ratio parameters
#'
#' @param .ratio
#'   Numeric: an odds ratio or risk ratio.
#'
#' @param .ratio_lower
#'   Numeric: the lower confidence interval of an odds ratio or risk ratio.
#'
#' @param .ratio_upper
#'   Numeric: the upper confidence interval of an odds ratio or risk ratio.
#'
#' @return
#'   A list of two values: is_valid (logical), and status (string).
#'
#' @export





validate_ratio <- function(.ratio = NA, .ratio_lower = NA, .ratio_upper = NA) {
  params <- list(.ratio, .ratio_lower, .ratio_upper)

  if (any(is.na(params))) {
    is_valid <- FALSE
    status <- "Error: missing parameter(s) for ratio."
    return(list(
      is_valid = is_valid,
      status = status
    ))
  }

  is_valid <- TRUE
  status <- "OK: parameters pass checks."

  return(list(
    is_valid = is_valid,
    status = status
  ))
}