R/area.R

In lawn: Client for 'Turfjs' for 'Geospatial' Analysis

#' Calculate the area of a polygon or group of polygons
#'
#' @export
#'
#' @param input A [data-Feature] or [data-FeatureCollection] of polygons
#' @template lint
#' @family measurements
#' @return A numeric in square meters
#' @examples
#' lawn_area(lawn_data$poly)
#' lawn_area(lawn_data$multipoly)
lawn_area <- function(input, lint = FALSE) {
  input <- convert(input)
  lawnlint(input, lint)
  if (lint) {
    is_type(input, type_top = c("Feature", "FeatureCollection"))
  }
  ct$eval(sprintf("var area = turf.area(%s);", input))
  ct$get("area")
}