R/attach_key.R

In JamesMCollier/densityviz: Density Visualizations and the STARS Package

#' View bivariate histograms with their keys
#'
#' @param plot a plot such as those returned from st_bivariate_histogram()
#' @param VizuKey a key built with Vizumap::build_bkey()
#' @param draw should the plot be drawn on the current device (default)? if FALSE, returns a grob without drawing. See gridExtra::arrangeGrob()
#'
#' @return draws on the current device or returns a grob
#' @export
#'
#' @examples
#' # Preparing the data
#' out <- st_assign_colors(tmax, 1, tmin, 1, terciles = FALSE)
#' data <- out$data
#' colors <- out$colors
#' bounds <- out$bounds
#'
#' # generating and plotting the histogram
#' bvh <- st_bivariate_histogram(data = data,
#'             title = "Max/Min temperature distribution")
#' bvh
#'
#' # creating and attaching the key
#' key <- Vizumap::build_bkey(data, colors, terciles = TRUE)
#' Vizumap::view(key)
#' attach_key(bvh, key)
attach_key = function(plot, VizuKey, draw = TRUE){
  k <- Vizumap::view(VizuKey)


  lay <- base::rbind(c(1, 1, 1, 1, NA, NA),
               c(1, 1, 1, 1, 2, 2),
               c(1, 1, 1, 1, 2, 2),
               c(1, 1, 1, 1, NA, NA))

  if(draw) gridExtra::grid.arrange(plot, k, layout_matrix = lay)
  else gridExtra::arrangeGrob(plot, k, layout_matrix = lay)
}