Learn R Programming

h3jsr (version 1.3.1)

are_neighbours: 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)

Value

Logical; TRUE if neighbours.

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.

Examples

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

Run the code above in your browser using DataLab