R/h3_geo-to-h3.R

In crazycapivara/h3forr: An R Interface to H3

## core functions

#' Get all hexagons containing [lat, lng] points
#'
#' @param coords numeric vector, matrix or data.frame with [lat, lng] pairs;
#' object of class \code{sf} (geometry type: \code{POINT})
#' @param res resolution of hexagons to return; number between 0 and 15
#'
#' @return H3 indexes; character vector
#'
#' @example inst/examples/api-reference/geo-to-h3.R
#'
#' @name geo_to_h3
#' @export
geo_to_h3 <- function(coords, res = 7) {
  UseMethod("geo_to_h3", coords)
}

#' @name geo_to_h3
#' @export
geo_to_h3.numeric <- function(coords, res = 7) {
  h3js_map("geoToH3", list(coords), res)
}

#' @name geo_to_h3
#' @export
geo_to_h3.matrix <- function(coords, res = 7) {
  h3js_map("geoToH3", coords, res)
}

#' @name geo_to_h3
#' @export
geo_to_h3.data.frame <- function(coords, res = 7) {
  h3js_map("geoToH3", as.matrix(coords), res)
}

#' @name geo_to_h3
#' @export
geo_to_h3.sf <- function(coords, res = 7) {
  #h3js_map("geoToH3", sf::st_coordinates(coords)[, c("Y", "X")], res)
  geo_to_h3(sf::st_coordinates(coords)[, c("Y", "X")], res)
}