R/sample.R

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

#' Return features from FeatureCollection at random
#'
#' Takes a [data-FeatureCollection] and returns a
#' [data-FeatureCollection] with given number of features at random.
#'
#' @export
#' @param features A [data-FeatureCollection]
#' @param n (integer) Number of features to generate.
#' @template lint
#' @family data functions
#' @return A [data-FeatureCollection]
#'
#' @examples
#' lawn_sample(lawn_data$points_average, 1)
#' lawn_sample(lawn_data$points_average, 2)
#' lawn_sample(lawn_data$points_average, 3)
lawn_sample <- function(features = NULL, n = 100, lint = FALSE) {
  if (!is.null(features)) lawnlint(features, lint)
  if (lint) is_type(features, type_top = "FeatureCollection")
  ct$eval(sprintf("var pts = turf.sample(%s, %s);", features, n))
  as.fc(ct$get("pts"))
}