is_valid {h3jsr}

check H3 cell index

Description

This function checks whether an H3 cell index is valid.

Usage

is_valid(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, a logical vector of length(h3_address).

Examples

# is the following cell index valid?
is_valid(h3_address = '8abe8d12acaffff')