R/add-meme.R

In sctyner/memer: A tidyverse compatible package for creating memes in R using magick

#' Add meme to `memer` package
#'
#' @param name Name of the meme in CamelCase.
#' @param file Filename including the file extension.
#'
#' @keywords internal
#'
#' @details `memer` uses `memer::blankmemes` to resolve filenames, so to use a
#' new meme you must build and install the package after running `meme_add()`.
#'
#' @examples
#' \dontrun{
#' memer:::meme_add("YoDawg", "yodawg.png")
#' }
meme_add <- function(name, file) {

  if (name %in% memer::blankmemes$name) {
    stop(paste0("Error: The ", name, " meme is already present in memer::blankmemes"))
  }

  cat('Make sure you have added the image file to the inst/extdata directory')

  blankmemes <- memer::blankmemes %>%
    dplyr::add_row(filename = file, name = name) %>%
    dplyr::arrange(filename) %>%
    dplyr::distinct() # make sure there aren't duplicates

  usethis::use_data(blankmemes, overwrite = T)

}