grid_distance: Grid distance between H3 cells

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

Grid distance between H3 cells

Description

This function gets the grid distance between two H3 cell indices.

Usage

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

Arguments

origin	Character vector or list of 15-character indices generated by H3.
destination	Character vector or list of 15-character indices generated by H3.
simple	Logical; whether to return a vector of outputs or a list object containing both inputs and outputs.

Value

The distance between two H3 cells, expressed as the minimum number of hexagon 'steps' required to get from the origin to the destination. Thus, a neighbour cell is one step away, and two cells with one hexagon between them are two steps apart.

Note

Input H3 indices must be of the same resolution or results cannot be computed. This function may fail to find the distance between two indices if they are very far apart or on opposite sides of a pentagon.

Examples

## Not run: 
nc <- sf::st_read(system.file("shape/nc.shp", package="sf"), quiet = TRUE)
nc_pts <- sf::st_centroid(nc[c(1, 2), ])
nc_6 <- point_to_cell(nc_pts, res = 6)
# how far apart are these two addresses?
grid_distance(nc_6[1], nc_6[2])

## End(Not run)

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