R/shortconnector.R

In moj-analytical-services/las_rap_code_library: Functions used for legal aid statistics publications and R Shiny apps

# shortconnector

#

#' Takes two differences and randomly judges which short connecting phrase should be used to compare the differences.

#' @param difference1 The first difference in the comparison
#' @param difference2 The second difference in the comparison
#' @examples
#' shortconnector(1, -7) #retunrs "whereas, " or "however, " or ", but" (as both values differ)
#' @export
#' 

shortconnector <- function(difference1, difference2){
tryCatch({
  # Check that only one value is passed to format_perc() at a time and raise
  # an error otherwise.
  if (length(difference1) > 1 | length(difference2) > 1) {
    stop(
      "Input to connector should be two arguments, each a single value. ",
      call. = FALSE
    )
  } else if  (is.null(difference1) | is.null(difference2)) {
    # Check that input is not null, and raise an error if it is
    stop("Input to connector is NULL", call. = FALSE)
  } else if (is.na(difference1) | is.na(difference2)) {
    # Check that input is not null, and raise and error if it is
    stop("Input to connector is NA", call. = FALSE)
  } else if (!is.numeric(difference1) | !is.numeric(difference1)) {
    stop("Input to connector is not a character", call. = FALSE)
  } else {
    # If checks of function pass, then run the main body of the function, and
    # return and output.
    # BODY --------------------------------------------------------------------
    if (difference1 * difference2 < 0)
    {
      sample((c("whereas, ", "however, ", ", but")),1)
    }
    else  {
      sample((c("also, ", "and ")),1)
    }
  }
}, warning = function(war){
  warning(war)
}, error = function(err){
  err$message <- paste("While producing the correct connector phrase", err, sep = " ")
  stop(err)
})
}