R/legend_range.R

In Schuch666/hackWRF: Functions to Work with WRF, NetCDF and Model Evaluation

#' Get the distance in kilometers between two points.
#'
#' @param x raster or array
#' @param y raster or array to mean (x is used only for the range in this case)
#' @param text.width Longitude in decimals
#' @param dig vector with number of digits for plot
#' @param xjust passed to legend
#' @param horiz passed to legend
#' @param x.intersp passed to legend
#' @param y.intersp passed to legend
#' @param show.mean set TRUE to hide mean value
#' @param unit a string for units
#' @param label_mean label in case y is provided
#' @param ... extra arguments passed to legend
#'
#' @note for use with raster use before any change of projection
#' @note text.width can vary depending on map dimensions
#'
#' @examples
#' library(raster)
#' br <- shapefile(paste0(system.file("extdata",package="hackWRF"),"/BR_states.shp"),verbose=FALSE)
#' plot(br)
#' box()
#' latitude()
#' longitude()
#' grid()
#' x <- eixport::wrf_get(paste0(system.file("extdata",package="hackWRF"),"/wrfinput_d01"),'XLAT')
#' legend_range(x)
#'
#' @export
#' @importFrom methods missingArg
#'
legend_range <- function(x, y,
                         text.width=NULL,
                         dig = c(2,2,2),
                         xjust = 0.5,
                         horiz = TRUE,
                         y.intersp =0.1,
                         x.intersp =0.1,
                         show.mean = TRUE,
                         unit = "",
                         label_mean = 'ALL:',
                         ...){

  if(class(x)[1] == 'Raster' ||
     class(x)[1] == 'RasterLayer' ||
     class(x)[1] == 'RasterBrick'){
    x <- raster_to_ncdf(x)
  }

  if(!missingArg(y)){
    if(class(y)[1] == 'Raster' ||
       class(y)[1] == 'RasterLayer' ||
       class(y)[1] == 'RasterBrick'){
      y <- raster_to_ncdf(y)
    }
  }

  mi <- paste('Min:', formatC(min(x, na.rm = TRUE), digits = dig[1], format = "f"),unit)
  if(missingArg(y)){
    me <- paste('Mean:',formatC(mean(x,na.rm = TRUE), digits = dig[2], format = "f"),unit)
  }else{
    me <- paste(label_mean,formatC(mean(y,na.rm = TRUE), digits = dig[2], format = "f"),unit)
  }
  ma <- paste('Max:', formatC(max(x, na.rm = TRUE), digits = dig[3], format = "f"),unit)

  if(show.mean){
    le <- c(mi,me,ma)
  }else{
    le <- c(mi,ma)
  }

  legend('bottomright',
         legend     = le,
         xjust      = xjust,
         horiz      = horiz,
         y.intersp  = y.intersp,
         x.intersp  = x.intersp,
         text.width = text.width,
         ...)
}