R/hex_extract.R

In evanmascitti/ecmfuns: A Compilation of My Own Personal R Functions

#'\lifecycle{experimental}
#'
#' Compute the average hex color of an image file
#'
#'Use this function to quickly extract the average color of an image for display
#'on screens. Helpful for visualization purposes and making realistic drawings
#'in vector graphics software such as Adobe Illustrator.
#'
#' @param image A cimg object which is an image file previously imported to the R session into R with `imager::load.image` (.png or .jpg)
#'
#' @return A character vector of length 1, containing average hexidecimal color
#'   of all pixels in the image
#' @export
#'
#'@examples \dontrun{
#'"image_file_1" %>%
#'imager::load.image() %>%
#'hex_extract() }
#'
#'
hex_extract <- function(image) {

  pkg_check(c("imager", "ImaginR"))

  image %>%
    ImaginR::PictureResults() %>%
    .[["const"]] %>%
    .[["color"]]
}