R/emodnet_map_plot.R

In EMODnet/EMODnetBiologyMaps: Creates ggplot maps with the style of EMODnet

#' Plot your spatial data following the EMODnet style
#'
#' @param data Data to be plotted in a map. Accepts sf, RasterLayer, "SpatialPolygonsDataFrame",
#' "SpatialPointsDataFrame", "SpatialLinesDataFrame"
#' @param fill column or vector used for filling in case of plotting a polygon.
#' @param title Title of the plot.
#' @param subtitle Subtitle of the plot.
#' @param legend Legend of the values.
#' @param crs Coordinate Reference System of the map. Default: LAEA Europe, EPGS:3035. Accepts EPGS and strings.
#' @param xlim Vector with minimum and maximum longitude. Default to Europe scale.
#' @param ylim Vector with minimum and maximum latitude. Default to Europe scale.
#' @param direction Direction in which the scale colors are drawn. Default 1. Reverse with -1.
#' @param option The color style used for the filling. Default "viridis". Try also "plasma"
#' @param zoom If TRUE, the size of the plot is calculated from the bounding box of the data. Otherwise
#' you should provide xlim and ylim to your desired size
#' @param plot_polygon_border if TRUE, the border of the polygon will be drawn. Default is TRUE. Set to FALSE
#' if you have small polygons compared to the size of the canvas.
#' @param ... params to be passed to emodnet_map_basic
#'
#' @return ggplot
#' @export
#'
#' @examples
#' aphiaid <- 107451
#' specname <- "Eriocheir sinensis"
#' Esgrid <- sf::st_read(paste0("http://geo.vliz.be/geoserver/wfs/ows?", "service=WFS&version=1.3.0&",
#' "request=GetFeature&", "typeName=Dataportal%3Aeurobis_grid_1d",
#' "-obisenv&", "viewParams=aphiaid%3A", aphiaid, "&", "outputFormat=json", "&maxFeatures=10"))
#' emodnet_map_plot(Esgrid, fill = Esgrid$RecordCount,  title = specname,
#' subtitle = paste("Aphiaid =", aphiaid), legend = "Abundance", plot_polygon_border = TRUE)
emodnet_map_plot <- function(data, fill = NULL, title = NULL, subtitle = NULL, legend = NULL,
                             crs = 3035, xlim = c(2426378.0132, 7093974.6215),
                             ylim = c(1308101.2618, 5446513.5222), direction = 1,
                             option = "viridis", zoom = FALSE, plot_polygon_border = TRUE, ...){
  # Quality check
  stopifnot(class(data)[1] %in% c("sf", "RasterLayer", "SpatialPolygonsDataFrame", "SpatialPointsDataFrame", "SpatialLinesDataFrame"))

  # Basic map
  emodnet_map_basic <- emodnet_map_basic(...) + ggplot2::ggtitle(label = title, subtitle = subtitle)

  # Logic
  # If data is raster
  if(class(data)[1] == "RasterLayer"){
    message("Transforming RasterLayer to sf vector data")
    data <- sf::st_as_sf(raster::rasterToPolygons(data))
  }

  # If data is sp
  if(class(data)[1] %in% c("SpatialPolygonsDataFrame", "SpatialPointsDataFrame", "SpatialLinesDataFrame")){
    message("Transforming sp to sf")
    data <- sf::st_as_sf(data)
  }

  # if data are sf points
  if(sf::st_geometry_type(data, FALSE) == "POINT"){
    emodnet_map_plot <- emodnet_map_basic +
      ggplot2::geom_sf(data = data,
                       color = emodnet_colors()$yellow)
  }

  # if data are sf polygons
  if(sf::st_geometry_type(data, FALSE) == "POLYGON"){
    if(is.null(fill)){
      fill <- sf::st_drop_geometry(data)[, 1]
    }
    if(plot_polygon_border){
      border_color <- "black"
    }else if(!plot_polygon_border){
      border_color <- NA
    }
    emodnet_map_plot <- emodnet_map_basic +
      ggplot2::geom_sf(data = data, ggplot2::aes(fill = fill), size = 0.05, color = border_color) +
      ggplot2::scale_fill_viridis_c(alpha = 0.8, name = legend, direction = direction, option = option)
  }

  # Projection and zoom
  if(zoom == TRUE){
    bbox <- sf::st_bbox(sf::st_transform(data, crs))
    xlim <- c(bbox$xmin, bbox$xmax)
    ylim <- c(bbox$ymin, bbox$ymax)
  }

  emodnet_map_plot <- emodnet_map_plot + ggplot2::coord_sf(crs = crs, xlim = xlim, ylim = ylim)

  # End
  return(emodnet_map_plot)

}