get_base_cell {h3jsr}

get the base cell of an H3 cell index

Description

This function returns the number of the base (Level 1) cell for an H3 cell idnex.

Usage

get_base_cell(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 0 to 121.

Examples

# What is Brisbane Town Hall's base cell number?
get_base_cell(h3_address = '8abe8d12acaffff')