get central child H3 cell index — get_centerchild • h3jsr

This function returns the central child of a particular H3 cell index at the requested resolution.

Usage

get_centerchild(h3_address = NULL, res = NULL, simple = TRUE)

Arguments

h3_address: Character; 15-character index generated by H3.
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 a data frame containing both inputs and outputs.

Value

By default, a list of length(h3_address). Each list element contains a vector of H3 cells.

Examples

# What is the central child of this resolution 6 index at resolution 8?
get_centerchild(h3_address = '86be8d12fffffff', res = 8)
#> [1] "88be8d1281fffff"