Cell to Child position

Get the position of the cell within an ordered list of all children of the cell's parent at the specified resolution.

Usage

cell_to_childpos(h3_address = NULL, parent_res = NULL, simple = TRUE)

Arguments

h3_address

Character; 15-character index generated by H3.

parent_res

numeric; resolution of reference parent cell.

simple

Logical; whether to return a vector or a data frame containing both inputs and outputs.

Value

Numeric, Position of child within parent at `parent_res`.

Note

Function will return 0 if `parent_res` is the same as the resolution of the supplied cell.

Examples

# example address has resolution 7
cell_to_childpos('872830b82ffffff', c(3,4,5,6), simple = FALSE)
#>        h3_address parent_res child_pos
#> 1 872830b82ffffff          3      2011
#> 2 872830b82ffffff          4       296
#> 3 872830b82ffffff          5         2
#> 4 872830b82ffffff          6         2