#' Remove small detached polygons (islands)
#'
#' Remove small detached polygons, keeping those with a minimum area and/or a
#' minimum number of vertices. Optionally remove null geometries.
#'
#' @param input spatial object to filter. One of:
#' \itemize{
#' \item \code{geo_json} or \code{character} polygons;
#' \item \code{SpatialPolygons*};
#' \item \code{sf} or \code{sfc} polygons object
#' }
#' @param min_area minimum area of polygons to retain. Area is calculated using
#' planar geometry, except for the area of unprojected polygons, which is
#' calculated using spherical geometry in units of square meters.
#' @param min_vertices minimum number of vertices in polygons to retain.
#' @param drop_null_geometries should features with empty geometries be dropped?
#' Default \code{TRUE}. Ignored for \code{SpatialPolyons*}, as it is always
#' \code{TRUE}.
#' @inheritDotParams apply_mapshaper_commands force_FC sys sys_mem quiet gj2008
#'
#' @return object with only specified features retained, in the same class as
#' the input
#'
#' @examples
#' library(geojsonsf)
#' library(sf)
#'
#' poly <- structure("{\"type\":\"FeatureCollection\",
#' \"features\":[{\"type\":\"Feature\",\"properties\":{},
#' \"geometry\":{\"type\":\"Polygon\",
#' \"coordinates\":[[[102,2],[102,4],[104,4],[104,2],[102,2]]]}},
#' {\"type\":\"Feature\",\"properties\":{},
#' \"geometry\":{\"type\":\"Polygon\",
#' \"coordinates\":[[[100,2],[98,4],[101.5,4],[100,2]]]}},
#' {\"type\":\"Feature\",\"properties\":{},
#' \"geometry\":{\"type\":\"Polygon\",
#' \"coordinates\":[[[100,0],[100,1],[101,1],[101,0],[100,0]]]}}]}",
#' class = c("geojson", "json"))
#'
#' poly <- geojson_sf(poly)
#' plot(poly)
#'
#' out <- ms_filter_islands(poly, min_area = 12391399903)
#' plot(out)
#'
#' @export
ms_filter_islands <- function(input, min_area = NULL, min_vertices = NULL, drop_null_geometries = TRUE,
...) {
if (!is.null(min_area) && !is.numeric(min_area)) stop("min_area must be numeric")
if (!is.null(min_vertices) && !is.numeric(min_vertices)) stop("min_vertices must be numeric")
if (!is.logical(drop_null_geometries)) stop("drop_null_geometries must be TRUE or FALSE")
UseMethod("ms_filter_islands")
}
#' @export
ms_filter_islands.character <- function(input, min_area = NULL, min_vertices = NULL, drop_null_geometries = TRUE,
...) {
input <- check_character_input(input)
cmd <- make_filterislands_call(min_area = min_area, min_vertices = min_vertices,
drop_null_geometries = drop_null_geometries)
apply_mapshaper_commands(data = input, command = cmd, ...)
}
#' @export
ms_filter_islands.json <- function(input, min_area = NULL, min_vertices = NULL, drop_null_geometries = TRUE,
...) {
cmd <- make_filterislands_call(min_area = min_area, min_vertices = min_vertices,
drop_null_geometries = drop_null_geometries)
apply_mapshaper_commands(data = input, command = cmd, ...)
}
#' @export
ms_filter_islands.SpatialPolygons <- function(input, min_area = NULL, min_vertices = NULL, drop_null_geometries = TRUE,
...) {
ms_filter_islands_sp(input, min_area = min_area, min_vertices = min_vertices, ...)
}
ms_filter_islands_sp <- function(input, min_area = NULL, min_vertices = NULL, ...) {
cmd <- make_filterislands_call(min_area = min_area, min_vertices = min_vertices,
drop_null_geometries = TRUE)
ms_sp(input = input, call = cmd, ...)
}
#' @export
ms_filter_islands.sf <- function(input, min_area = NULL, min_vertices = NULL,
drop_null_geometries = TRUE, ...) {
cmd <- make_filterislands_call(min_area = min_area, min_vertices = min_vertices,
drop_null_geometries = TRUE)
ms_sf(input = input, call = cmd, ...)
}
#' @export
ms_filter_islands.sfc <- ms_filter_islands.sf
make_filterislands_call <- function(min_area, min_vertices, drop_null_geometries) {
if (!is.null(min_area)) min_area <- paste0("min-area=", min_area)
if (!is.null(min_vertices)) min_vertices <- paste0("min-vertices=", min_vertices)
if (drop_null_geometries) rem <- "remove-empty" else rem <- NULL
call <- list("-filter-islands", min_area, min_vertices, rem)
call
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.