h3jsr (version 1.3.1)

polygon_to_cells: Get H3 cell index within a polygon

Description

This function returns all the H3 cell indexes within the supplied polygon geometry.

Usage

polygon_to_cells(geometry = NULL, res = NULL, simple = TRUE)

Value

By default, a list of length(h3_address). Each list element contains a character vector of H3 cell indices belonging to that geometry. A result of NA indicates that no H3 cell indices of the chosen resolution are centered over the geometry.

Arguments

geometry

sf object of type POLYGON or MULTIPOLYGON.

res

Integer; Desired H3 resolution. See https://h3geo.org/docs/core-library/restable/ for allowable values and related dimensions.

simple

Logical; whether to return a vector of outputs or an sf object containing both inputs and outputs.

Examples

# Which level 5 H3 cell indices have centers inside County Ashe, NC?
nc <- sf::st_read(system.file("shape/nc.shp", package="sf"), quiet = TRUE)
nc1 <- nc[1, ]
fillers <- polygon_to_cells(geometry = nc1, res = 5)