R/validate_risk_ratio.R

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

#' @title
#'   Check if the risk ratio parameters are sufficient
#'
#' @param .rratio
#'   Numeric: a risk ratio.
#'
#' @param .rratio_lo
#'   Numeric: the lower confidence interval of a risk ratio.
#'
#' @param .rratio_up
#'   Numeric: the upper confidence interval of a risk ratio.
#'
#' @return
#'   A list of two values: is_valid (logical), and status (string).
#'
#' @export





validate_risk_ratio <- function(.rratio = NA, .rratio_lo = NA, .rratio_up = NA) {
  params <- list(.rratio, .rratio_lo, .rratio_up)

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

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

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