R/gp_plot.R

In KaiAragaki/Plate: A Grammar of Plates

#' Plot a `gp` object
#'
#' @param x A `gp` object or `data.frame`
#' @param name Symbol. Name of a column in `gp$well_data` (or a column in the
#'   data.frame if data.frame was supplied) to use as a color.
#' @param ... Additional arguments to be passed to `ggplot2::geom_point()`
#'
#' @return a `ggplot`
#' @export
#'
#' @examples
#'
#' gp(16, 24) |> gp_plot(.row)
gp_plot <- function(x, name = .sec, ...) {
  UseMethod("gp_plot")
}

#' @rdname gp_plot
#' @export
gp_plot.gp <- function(x, name = .sec, ...) {
  dots <- rlang::dots_list(..., size = 4, .homonyms = "first")

  wd <- x$well_data
  ggplot2::ggplot(wd, ggplot2::aes(x = .col, y = .row, color = {{ name }})) +
    ggplot2::geom_point(...) +
    ggplot2::scale_y_reverse()
}

#' @rdname gp_plot
#' @export
gp_plot.data.frame <- function(x, name = .sec, ...) {
  dots <- rlang::dots_list(..., size = 4, .homonyms = "first")

  ggplot2::ggplot(x, ggplot2::aes(x = .col, y = .row, color = {{ name }})) +
    ggplot2::geom_point(...) +
    ggplot2::scale_y_reverse()
}

#' A theme for making little in-line plots
#'
#' @return A `ggplot2` theme
#' @export
gp_mini_theme <- function() {
  ggplot2::theme(panel.grid = ggplot2::element_blank(),
                 panel.background = ggplot2::element_rect(fill = "#FFFFF8",
                                                          color = "#FFFFF8"),
                 plot.background = ggplot2::element_rect(fill = "#FFFFF8"),
                 strip.background = ggplot2::element_rect(fill = "#FFFFF8"),
                 legend.background = ggplot2::element_rect(fill = "#FFFFF8"),
                 legend.position = "none",
                 legend.key = ggplot2::element_blank(),
                 axis.text = ggplot2::element_blank(),
                 axis.title = ggplot2::element_blank(),
                 axis.ticks = ggplot2::element_blank())
}