R/median.R

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

#' Median value of a field among points within polygons
#'
#' Calculates the **median** value of a field for a set of
#' [data-Point]'s within a set of [data-Polygon]'s.
#'
#' @export
#' @template math
#' @template lint
#' @family aggregations
#' @return A FeatureCollection of [data-Polygon] features with
#' properties listed as `out_field`.
#' @examples \dontrun{
#' poly <- lawn_data$polygons_average
#' pt <- lawn_data$points_average
#' lawn_median(polygons=poly, points=pt, in_field='population')
#' }
lawn_median <- function(polygons, points, in_field, out_field = "median",
                        lint = FALSE) {

  lawnlint(list(polygons, points), lint)
  calc_math("median", convert(polygons), convert(points), in_field, out_field)
}