R/plot_comic.R

In koalaverse/RBitmoji: An R Wrapper to the Overly Complicated 'Bitmoji' API

#' Plot Bitmoji comic
#'
#' Plot a Bitmoji comic.
#'
#' @param id Character string specifying the users unique ID. Can also be a
#' vector of length 2.
#'
#' @param tag Character string specifying the keyword tag (e.g.,
#' \code{"birthday"}).
#'
#' @param comic_id Character string specifying the comic id (e.g.,
#' \code{"10228108"}).
#'
#' @param transparent Logical indicating whether or not the background should be
#' transparent. Default is \code{FALSE} (i.e., the background will be white).
#'
#' @export
#'
#' @examples
#' # ID obtained using get_id()
#' my_id <- "1551b314-5e8a-4477-aca2-088c05963111-v1"
#' plot_comic(my_id, tag = "edvard")
#' plot_comic(my_id, comic_id = "10224100")
#'
#' # Plot with friends
#' plot_comic(c(my_id, my_id), tag = "sloth")
plot_comic <- function(id, tag = NULL, comic_id = NULL, transparent = FALSE) {
  img <- get_comic(id, tag = tag, comic_id = comic_id,
                   transparent = transparent)
  # usr <- par()
  graphics::par(mar = c(0, 0, 0, 0) + 0.1)
  graphics::plot(grDevices::as.raster(img))
}