R/quadrat.R

In zonebuilders/zonebuilder: Create and Explore Geographic Zoning Systems

#' Divide a region into quadrats
#'
#' @param x x 
#' @param ncol ncol 
#' @param nrow nrow
#' @param intersection intersection
#'
#' @return An sf object
#' @export
#'
#' @examples
#' x = london_a()
#' c = sf::st_centroid(london_a())
#' plot(zb_quadrat(x, ncol = 2), col = 2:5)
#' plot(c, add = TRUE, col = "white")
#' plot(zb_quadrat(x, ncol = 3))
#' plot(zb_quadrat(x, ncol = 4))
#' plot(zb_quadrat(x, ncol = 4, intersection = FALSE))
zb_quadrat = function(x, ncol, nrow = NULL, intersection = TRUE) {
  g = sf::st_make_grid(x = x, n = ncol)
  if(!intersection) {
    return(g)
  }
  sf::st_intersection(x, g)
}