R/ne_coastline.R

In rnaturalearth: World Map Data from Natural Earth

#' Get natural earth world coastline
#'
#' returns world coastline at specified scale
#'
#' @param scale scale of map to return, one of \code{110}, \code{50}, \code{10}
#' or \code{'small'}, \code{'medium'}, \code{'large'}
#'
#' @param returnclass 'sp' default or 'sf' for Simple Features
#'
#' @examples
#' if (requireNamespace("rnaturalearthdata")) {
#'   sldf_coast <- ne_coastline()
#'
#'   if (require(sp)) {
#'     plot(sldf_coast)
#'   }
#' }
#'
#' @return \code{SpatialLinesDataFrame} or \code{sf}
#'
#' @export
ne_coastline <- function(scale = 110,
                         returnclass = c("sp", "sf")) {
  returnclass <- match.arg(returnclass)

  if (returnclass == "sp") {
    deprecate_sp("ne_download(returnclass = 'sp')")
  }

  # check for the data packages and try to install if not there
  if (scale == 10) {
    check_rnaturalearthhires()
  } else {
    check_rnaturalearthdata()
  }

  # check on permitted scales, convert names to numeric
  scale <- check_scale(scale)

  # choose which map based on scale
  sldf <- NULL

  if (scale == 110) {
    sldf <- rnaturalearthdata::coastline110
  } else if (scale == 50) {
    sldf <- rnaturalearthdata::coastline50
  } else if (scale == 10) {
    sldf <- rnaturalearthhires::coastline10
  }

  # convert to sf if chosen
  ne_as_sp(sldf, returnclass)
}