R/h3_hierachy.R

In crazycapivara/h3-r: R Bindings for H3

#' Get the parent of the given hexagon at a particular resolution.
#' @param h3_index character scalar representing a valid H3 index
#' @param res resolution of parent
#' @return character scalar
#' @export
h3_to_parent <- function(h3_index, res) {
  rcpp_h3_to_parent(h3_index, res)
}

#' Get the children of the given hexagon at a particular resolution.
#' @inheritParams h3_to_parent
#' @param res resolution of children
#' @return character vector
#' @export
h3_to_children <- function(h3_index, res) {
  rcpp_h3_to_children(h3_index, res)
}

#' Compact a set of hexagons of the same resolution into a set of hexagons across multiple levels.
#' @param h3_indexes character vector of H3 indexes
#' @export
compact <- function(h3_indexes) {
  rcpp_compact(h3_indexes)
}