is_pentagon: check if H3 cell index is a pentagon

View source: R/core_api.R

is_pentagonR Documentation

check if H3 cell index is a pentagon

Description

This function checks whether a H3 cell index refers to one of the pentagons that occur at icosahedron corners.

Usage

is_pentagon(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 a pentagon?
is_pentagon(h3_address = '8abe8d12acaffff')

obrl-soil/h3jsr documentation built on Jan. 27, 2024, 4:33 a.m.