get_faces {h3jsr}

get the icosahedron faces of an H3 cell index

Description

This function returns the indices of all icosahedron faces intersected by a given H3 cell index.

Usage

get_faces(h3_address = NULL, simple = TRUE)

Arguments

h3_address

Character; 15-character index generated by H3.

simple

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

Value

By default, an integer vector of length(h3_address), ranging from 1 to 20. If simple = FALSE, a data.frame with a column of H3 cell indexes and a list-column of faces.

Examples

# Which faces does this h3 cell index intersect?
get_faces(h3_address = '8abe8d12acaffff')