R/grid.R

In heavywatal/rwtl: Personal R package

#' Wrappers of grid functions
#'
#' @description
#' `gprint()` is a shortcut for [grid::grid.draw()].
#' @param newpage logical
#' @inheritParams grid::grid.draw
#' @rdname grid
#' @export
gprint = function(x, newpage = TRUE, recording = FALSE) {
  if (newpage) grid::grid.newpage(recording)
  grid::grid.draw(x, recording)
  invisible(x)
}

#' @description
#' `grid.draw.list()` enables writing multi-page PDF via [ggplot2::ggsave()].
#' @inheritParams grid::grid.draw
#' @importFrom grid grid.draw
#' @method grid.draw list
#' @rdname grid
#' @export
grid.draw.list = function(x, recording = FALSE) {
  lapply(x, grid::grid.draw, recording = recording)
  invisible(x)
}

#' @description
#' `as_gg()` converts grob to gg.
#' @param grob graphical object
#' @rdname grid
#' @export
as_gg = function(grob) {
  ggplot2::ggplot(data.frame(x = 0:1, y = 0:1)) +
    ggplot2::annotation_custom(grob) +
    ggplot2::scale_x_continuous(limits = 0:1, expand = c(0, 0)) +
    ggplot2::scale_y_continuous(limits = 0:1, expand = c(0, 0))
}