R/methods.R

In mayer79/apero: Apero

#' Prints an Apero
#'
#' Print method for an object of class "apero".
#'
#' @param x An object of class "apero".
#' @param ... Further arguments passed from other methods.
#' @return Invisibly, the input is returned.
#' @export
#' @examples
#' x <- apero()
#' x
#'
#' x2 <- apero(1, 1)
#' x2
print.apero <- function(x, ...) {
  n <- nrow(x$guests)

  cat("The apero takes place in a ", x$room_length, "m x ", x$room_width,
      "m room and the safety distance is ", x$min_distance, "m.\n", sep = "")
  if (n == 1L) {
    cat("Oh no, you are all alone - the room is simply too small!\n",
        "At least you are not at risk catching a virus...\n")
  } else {
    cat("A whopping", n, "guests are here (incl. you). Nice apero so far!\n")
  }
  invisible(x)
}

#==============================================================================

#' Summarizes an Apero
#'
#' Summary method for an object of class "apero".
#'
#' @param object An object of class "apero".
#' @param ... Further arguments passed from other methods.
#' @return Invisibly, the number of clinks is returned.
#' @export
#' @examples
#' x <- apero()
#' summary(x)
#'
#' x2 <- apero(2, 1)
#' summary(x2)
summary.apero <- function(object, ...) {
  print(object)
  nclinks <- clinks(object)
  if (nclinks == 0L) {
    cat("There won't be any clink. Lucky glass...")
  } else {
    cat("There will be", nclinks, "clinks. Poor glasses...")
  }
  invisible(nclinks)
}

#==============================================================================

#' Plots an Apero
#'
#' Plot method for an object of class "apero".
#'
#' @param x An object of class "apero".
#' @param emo An emoji like "beer", "drink", "syringe", "wine_glass".
#'   Use `emojifont::search_emoji("glass", approximate = TRUE)` to find the right word.
#' @param size Size of emoji.
#' @param color Color of emoji.
#' @param ... Further arguments passed to `ggplot2::geom_text()`.
#' @return A "ggplot" object.
#' @export
#' @examples
#' x <- apero()
#' x
#' plot(x)
#' plot(x, emo = "syringe", color = "red")
#'
#' x2 <- apero(2, 1)
#' plot(x2)
plot.apero <- function(x, emo = "beer", size = 8, color = "orange", ...) {
  emojifont::load.emojifont()
  ggplot2::ggplot() +
    ggplot2::geom_rect(
      ggplot2::aes(xmin = xmin, xmax = xmax, ymin = ymin, ymax = ymax),
      data = data.frame(
        xmin = -x$room_length / 2, xmax = x$room_length / 2,
        ymin = -x$room_width / 2,  ymax = x$room_width / 2
      ),
      fill = "grey95"
    ) +
    ggplot2::geom_text(
      ggplot2::aes(x = x, y = y),
      x$guests,
      label = emojifont::emoji(emo),
      size = size,
      family="EmojiOne",
      color = color,
      ...
    ) +
    ggplot2::scale_y_continuous(expand = c(0, 0)) +
    ggplot2::scale_x_continuous(expand = c(0, 0)) +
    ggplot2::theme_minimal() +
    ggplot2::coord_equal() +
    ggplot2::labs(
      title = paste0(
        "Apero with ", nrow(x$guests),
        " persons and a safety distance of ",
        x$min_distance, "m"
      ),
      x = paste0("Length of the room: ", x$room_length, "m"),
      y = paste0("Width of the room: ", x$room_width, "m"),
    ) +
    ggplot2::theme(
      panel.grid.major = ggplot2::element_blank(),
      panel.grid.minor = ggplot2::element_blank(),
      axis.text = ggplot2::element_blank(),
      axis.ticks = ggplot2::element_blank(),
      plot.title = ggplot2::element_text(size = 12)
    )
}

# To avoid a note on undefined global variables
globalVariables(c("xmin", "xmax", "ymin", "ymax", "y"))