R/arrow_pdf.R

In moj-analytical-services/mojrap: Generic Functions for Reproducible Analytical Pipelines in MoJ

#' Output arrow image for table on PDF bulletin front page
#'
#' @description Function to format the correct path to arrow images for PDF bulletin front page.
#'
#' @param x Number (usually the difference between two figures)
#' @param path The path to the directory containing the arrow images. Default is a folder called 'images' in the repo root directory.
#
#' @examples
#' arrow_pdf(5)
#'
#' @return Path to image of upwards arrow if x is positive, downwards arrow if x is negative or a no change arrow when x is zero.
#'
#' @export

arrow_pdf <- function(x, path="images"){

  if (is.numeric(x) == FALSE){
    stop("Input must be a number representing a difference between two figures")
  }

  if (x > 0){

    arrow_image("up", image_path = path)

  }
  else if (x < 0){

    arrow_image("down", image_path = path)

  }
  else {

    arrow_image("nochange", image_path = path)

  }

}