make gp_plot more generic, document

DESCRIPTION

@@ -12,7 +12,7 @@ License: GPL (>= 3)
 Encoding: UTF-8
 LazyData: true
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.2
 Imports: 
     cli,
     dplyr,

NAMESPACE

@@ -2,6 +2,8 @@
 
 S3method(as_gp,default)
 S3method(as_gp,list)
+S3method(gp_plot,data.frame)
+S3method(gp_plot,gp)
 S3method(gp_sec,gp)
 S3method(print,gp)
 S3method(well_data,gp)

R/gp_plot.R

@@ -1,7 +1,8 @@
 #' Plot a `gp` object
 #'
-#' @param gp A `gp` object
-#' @param name Symbol. Name of a column in `gp$well_data` to use as a color.
+#' @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`
@@ -10,15 +11,31 @@
 #' @examples
 #'
 #' gp(16, 24) |> gp_plot(.row)
-gp_plot <- function(gp, name = .sec, ...) {
+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 <- gp$well_data
+  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