get_children {h3jsr}

get child H3 cell indices

Description

This function returns the children of a particular H3 cell at the requested resolution.

Usage

get_children(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 cell indexes.

Note

The number of cells returned for each request is 7 ^ (parent_res - child_res), so jumping three levels will return 343 indexes per request. This can cause memory issues with larger requests.

Examples

# What are the children of this resolution 6 cell index at resolution 8?
get_children(h3_address = '86be8d12fffffff', res = 8)