Merge pull request #5 from billdenney/export-more

export `new_gglist()`

Author: billdenney

NAMESPACE

@@ -20,6 +20,8 @@ export(ggtibble)
 export(group_vars)
 export(knit_print)
 export(labs_glue)
+export(new_gglist)
+export(new_ggtibble)
 export(vec_arith)
 importFrom(dplyr,group_vars)
 importFrom(ggplot2,ggplot)

NEWS.md

@@ -2,3 +2,5 @@
 
 * Labels created with the `labs` argument to `ggtibble()` will not longer all be
   the same (#3)
+* `new_gglist()` and `new_ggtibble()` are now exported making it easier to
+  create objects.

R/gglist.R

@@ -18,6 +18,14 @@ gglist <- function(data = NULL, mapping = ggplot2::aes(), ..., environment = par
   )
 }
 
+#' Create a new `gglist` object
+#'
+#' @param x A list of ggplot2 objects to convert into a gglist
+#' @returns The list verified to be a gglist and with the gglist class
+#' @family New ggtibble objects
+#' @examples
+#' new_gglist(list(NULL, ggplot2::ggplot(data = data.frame())))
+#' @export
 new_gglist <- function(x = list()) {
   if (!inherits(x, "list")) {
     stop("`x` must be a list")

R/ggtibble.R

@@ -55,7 +55,7 @@ ggtibble.data.frame <- function(data, mapping = ggplot2::aes(), ..., outercols =
   d_plot <- tidyr::nest(.data = data, data_plot = !tidyr::all_of(outercols))
   d_plot$figure <- gglist(data = d_plot$data_plot, mapping = mapping, ...)
   d_plot$caption <- glue::glue_data(d_plot, caption)
-  class(d_plot) <- c("ggtibble", class(d_plot))
+  d_plot <- new_ggtibble(d_plot)
   if (length(labs) > 0) {
     d_plot$figure <-
       d_plot$figure +
@@ -67,6 +67,25 @@ ggtibble.data.frame <- function(data, mapping = ggplot2::aes(), ..., outercols =
   d_plot
 }
 
+#' Create a new `ggtibble` object
+#'
+#' @param x A data.frame with a column named "figure" and "caption", and where
+#'   the "figure" column is a ggtibble.
+#' @returns The object with a ggtibble class
+#' @family New ggtibble objects
+#' @examples
+#' new_ggtibble(tibble::tibble(figure = list(ggplot2::ggplot()), caption = ""))
+#' @export
+new_ggtibble <- function(x) {
+  stopifnot(is.data.frame(x))
+  stopifnot(c("figure", "caption") %in% names(x))
+  if (!inherits(x$figure, "gglist")) {
+    x$figure <- new_gglist(x$figure)
+  }
+  class(x) <- unique(c("ggtibble", class(x)))
+  x
+}
+
 #' @describeIn knit_print.gglist Print the plots in a `ggtibble` object
 #' @export
 knit_print.ggtibble <- function(x, ...) {

man/new_gglist.Rd

@@ -141,3 +141,10 @@ test_that("labels are not always the same (#3)", {
 
   expect_true(fig1$labels$x != fig2$labels$x)
 })
+
+test_that("new_ggtibble() works", {
+  expect_s3_class(
+    new_ggtibble(tibble::tibble(figure = list(ggplot2::ggplot()), caption = "")),
+    "ggtibble"
+  )
+})