R/h3_uniedge.R

In crazycapivara/h3-r: R Bindings for H3

#' Get the coordinates defining the unidirectional edge.
#' @param h3_edge_index character scalar; H3 edge index
#' @export
get_h3_unidirectional_edge_boundary <- function(h3_edge_index) {
  rcpp_get_h3_unidirectional_edge_boundary(h3_edge_index)
}

#' Get all of the unidirectional edges from the given H3 index.
#' @param h3_index character scalar; H3 index
#' @example inst/examples/api-reference/get-h3-unidirectional-edges-from-hexagon.R
#' @export
get_h3_unidirectional_edges_from_hexagon <- function(h3_index) {
  rcpp_get_h3_unidirectional_edges_from_hexagon(h3_index)
}

#' Get the origin hexagon from the unidirectional H3 edge index.
#' @inheritParams get_h3_unidirectional_edge_boundary
#' @export
get_origin_h3_index_from_unidirectional_edge <- function(h3_edge_index) {
  rcpp_get_origin_h3_index_from_unidirectional_edge(h3_edge_index)
}

#' Get the destination hexagon from the unidirectional H3 edge index.
#' @inheritParams get_h3_unidirectional_edge_boundary
#' @export
get_destination_h3_index_from_unidirectional_edge <- function(h3_edge_index) {
  rcpp_get_destination_h3_index_from_unidirectional_edge(h3_edge_index)
}