get_udedge {h3jsr}

Get a unidirectional edge index

Description

Returns an H3 index representing a unidirectional edge for a given origin and destination cell pair.

Usage

get_udedge(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

By default, character vector of unidirectional edge indexes.

Note

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

Examples

# Return the unidirectional edge representing the transition between these two cells:
get_udedge(origin = '86be8d12fffffff', destination = '86be8d127ffffff')