R/get_plot_limits.R

In jfq3/QsRutils: R Functions Useful for Community Ecology

#' Get ggplot Plot Limits
#' 
#' Gets the ranges for the width and height of a ggplot panel.
#' 
#' @param plot A plot created with ggplot2
#'
#' @return A list: xmin, xmax, ymin, ymax
#' @export
#' @examples
#' library(ggplot2)
#' data(iris)
#' plt <- ggplot(data=iris, aes(x=Species, y=Petal.Length)) + geom_boxplot()
#' get_plot_limits(plt)
get_plot_limits <- function(plot) {
  gb = ggplot2::ggplot_build(plot)
  xmin = gb$layout$panel_params[[1]]$x.range[1]
  xmax = gb$layout$panel_params[[1]]$x.range[2]
  ymin = gb$layout$panel_params[[1]]$y.range[1]
  ymax = gb$layout$panel_params[[1]]$y.range[2]
  list(xmin = xmin, xmax = xmax, ymin = ymin, ymax = ymax)
}