are_neighbours: check if H3 cells are neighbours

In obrl-soil/h3jsr: Access Uber's H3 Library

check if H3 cells are neighbours

Description

This function checks whether two H3 cells share an edge.

Usage

are_neighbours(origin = NULL, destination = NULL, simple = TRUE)

Arguments

origin	Character; 15-character cell index generated by H3. A vector of indexes can also be supplied.
destination	Character; 15-character cell index generated by H3. A vector of indexes can also be supplied.
simple	Logical; whether to return a vector of outputs or a data frame containing both inputs and outputs.

Value

Logical; TRUE if neighbours.

Note

• The number of indexes supplied to origin and destination must be equal.

• This function will always return false if the indexes are of different resolutions.

Examples

# Are the following cells neighbours?
are_neighbours(origin = '86be8d12fffffff', destination = '86be8d127ffffff')

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