R/colorize.R

In zumbov2/colorizer: Colorize Old Images Using the 'DeOldify' Image Colorization API

#' Call Image Colorization API
#'
#' \code{colorize} calls the DeOldify image colorization API on DeepAI.
#'
#' @param img path or URL to the images to be colorized.
#' @param key DeepAI API key.
#' @param pane defines in which pane the image is displayed: \code{plot}, \code{view} or \code{none}.
#'
#' @details With the default API key a few queries are possible. After registration on DeepAI
#'    \url{https://deepai.org/}, around 5000 free requests are currently possible.
#'
#' @return A tibble with the file locations of the original images and the response URLs to
#'    the colorized images. The latter expire after some time. It is recommended to save the
#'    colorized images.
#'
#' @examples
#' \dontrun{
#' # Call image colorization API
#' colorize(img = "https://upload.wikimedia.org/wikipedia/commons/9/9e/Breadfruit.jpg")
#' }
#' @export
#' @importFrom purrr map_dfr
colorize <- function(img, key = "quickstart-QUdJIGlzIGNvbWluZy4uLi4K", pane = c("plot", "view", "none")) {

  # Check arguments
  check_pane(pane)

  # Colorize
  response <- purrr::map_dfr(
    img,
    colorize_wh,
    key = key,
    pane = pane[1]
    )

  # Return response
  return(invisible(response))

}