Package 'h3r'

Description

Returns whether or not the provided H3 cell indexes are neighbors

Usage

areNeighborCells(origin, destination)

Arguments

Value

1 if the indexes are neighbors, 0 otherwise.

Examples

areNeighborCells(
  origin = c("85283473fffffff","85283473fffffff")
  , destination = c("85283471fffffff","85283477fffffff")
 )

Description

Exact area of specific cell in square kilometers.

Usage

cellAreaKm2(cell)

Arguments

Value

the exact area of specific cell in square kilometers.

Examples

cellAreaKm2(cell = c("8cbe63562a54bff","8cbe635631103ff"))

Description

Exact area of specific cell in square meters.

Usage

cellAreaM2(cell)

Arguments

Value

the exact area of specific cell in square meters.

Examples

cellAreaM2(cell = c("8cbe63562a54bff","8cbe635631103ff"))

Description

Exact area of specific cell in square radians.

Usage

cellAreaRads2(cell)

Arguments

Value

the exact area of specific cell in square radians.

Examples

cellAreaRads2(cell = c("8cbe63562a54bff","8cbe635631103ff"))

Description

Returns a unidirectional edge H3 index based on the provided origin and destination.

Usage

cellsToDirectedEdge(origin, destination)

Arguments

Value

a unidirectional edge H3 index based on the provided origin and destination.

Examples

cellsToDirectedEdge(
  origin = c("85283471fffffff","85283473fffffff")
  , destination = c("85283475fffffff","85283477fffffff")
 )

Description

Cell To Boundary

Usage

cellToBoundary(cell)

Arguments

Value

named list, each element named with the input H3 cell, and containing a lat and lng vector

Examples

cellToBoundary(cell = c("8cbe63562a54bff","8cbe635631103ff"))

Description

Provies the center child index contained by cell at the childRes resolution

Usage

cellToCenterChild(cell, childRes)

Arguments

Value

index of the child cells

Examples

cellToCenterChild(
  cell = c("85283473fffffff","85283473fffffff")
  , childRes = c(7L, 8L)
 )

Description

Returns the position of the child cell within an ordered list of all children of the cell's parent at the specified resolution parentRes.

Usage

cellToChildPos(cell, parentRes)

Arguments

Value

the position of the child cell

Examples

cellToChildPos(
  cell = c("8cbe63562a54bff","8cbe635631103ff")
  , parentRes = c(1L, 2L)
 )

Description

Returns all the H3 indexes contained by the input cell at the defined child resolution

Usage

cellToChildren(cell, childRes)

Arguments

Value

a named list, where each element is the input cell, and the values of each element are the child H3 cells

Examples

cell <- "8cbe63562a54bff"
currentResolution <- getResolution(cell = cell)

cellToChildren(cell, childRes = currentResolution + 1L)
cellToChildren(cell, childRes = currentResolution + 2L)

res0 <- getRes0Cells()
cellToChildren(res0[1], 1L)
cellToChildren(res0[1], 2L)

cellToChildren(res0[1:5], 1L:5L)

Description

Finds the center of the cell in grid space

Usage

cellToLatLng(cell)

Arguments

Value

a list of two vectors, lat and lng, each the same length as cell, giving the center of cell

Examples

cellToLatLng(cell = c("8cbe63562a54bff","8cbe635631103ff"))

Description

Produces local IJ coordinates for an H3 index anchored by an origin.

Usage

cellToLocalIj(origin, cell)

Arguments

Value

(i, j) coordinates

Examples

cellToLocalIj(
  origin = c("85283473fffffff","85283473fffffff")
  , cell = c("8528342bfffffff","85283477fffffff")
 )

Description

Provides the parent (coarser) index containing cell

Usage

cellToParent(cell, parentRes)

Arguments

Value

vector of parent cells for each cell

Examples

cell <- "8cbe63562a54bff"
getResolution(cell = cell)

## The `parentRes` should be a lower value than the result of  `getResolution()`
cellToParent(cell = rep(cell, 2), parentRes = c(11L, 10L))

## Specifying a single resolution
cells <- c("8cbe63562a54bff", "8cbe635631103ff")
getResolution(cell = cells)

cellToParent(cell = cells, parentRes = 6)
cellToParent(cell = cells, parentRes = 7)

Description

Returns the index for the specified cell vertex. Valid vertex numbers are between 0 and 5 (inclusive) for hexagonal cells, and 0 and 4 (inclusive) for pentagonal cells.

Usage

cellToVertex(cell, vertexNum)

Arguments

Value

vector of vertex indexes

Examples

cellToVertex(
  cell = c(rep("8cbe63562a54bff", 6))
  , vertexNum = c(0L:5L)
  )

Description

Returns the indexes for all vertices of the given cell. The Output will have a 0 in the result if the input cell is a pentagon

Usage

cellToVertexes(cell)

Arguments

Value

list of vectors giving the vertices of each cell. Each list element corresponds to the cell index given in the cell argument, and each element of the vector are the cell vertexes.

Examples

cellToVertexes(cell = c("8cbe63562a54bff", "8cbe635631103ff") )

Description

Returns the child cell at a given position within an ordered list of all children of parent at the specified resolution childRes.

Usage

childPosToCell(childPos, cell, childRes)

Arguments

Value

the position of the child cell

Examples

childPosToCell(
  childPos = c(42, 41)
  , cell = c("85283473fffffff","85283473fffffff")
  , childRes = c(7L, 7L)
)

Description

Compacts the set cellSet of indexes as best as possible, into the array compactedSet.

Usage

compactCells(cellSet)

Arguments

Value

a list of character vectors containing the compacted H3 cell indexes

Examples

compactCells(gridDisk(cell = c("8cbe63562a54bff","8cbe635631103ff"), k = c(1L, 2L)))

Description

Converts Degrees to Radians

Usage

degsToRads(deg)

Arguments

Value

numeric vector giving the input deg values as radians

Examples

degsToRads(deg = seq(0, 360, by = 15))

Description

Directed edge To Boundary

Usage

directedEdgeToBoundary(edge)

Arguments

Value

named list, each element named with the input H3 cell, and containing a lat and lng vector

Examples

directedEdgeToBoundary(edge = c("115283473fffffff","115283477fffffff"))

Description

Get the origin and destination cells of the unidirectional edge

Usage

directedEdgeToCells(edge)

Arguments

Value

the origin, destination pair of hexagon IDs for the given edge ID

Examples

directedEdgeToCells(edge = c("115283473fffffff","115283471fffffff"))

Description

Get the exact edge length of specific unidirectional edge in kilometers.

Usage

edgeLengthKm(edge)

Arguments

Value

the exact edge length of specific unidirectional edge in kilometers.

Examples

edgeLengthKm(edge = c("13d2a1672b34ffff","16a2a1072b59ffff"))

Description

Get the exact edge length of specific unidirectional edge in meters.

Usage

edgeLengthM(edge)

Arguments

Value

the exact edge length of specific unidirectional edge in meters.

Examples

edgeLengthM(edge = c("13d2a1672b34ffff","16a2a1072b59ffff"))

Description

Get the exact edge length of specific unidirectional edge in radians.

Usage

edgeLengthRads(edge)

Arguments

Value

the exact edge length of specific unidirectional edge in radians.

Examples

edgeLengthRads(edge = c("13d2a1672b34ffff","16a2a1072b59ffff"))

Description

Returns the base cell number of the index

Usage

getBaseCellNumber(cell)

Arguments

Value

a vector the same length as cell giving the base cell number of each index

Examples

getBaseCellNumber(cell = c("8cbe63562a54bff","8cbe635631103ff"))

Description

Get the destination cell of the unidirectional edge

Usage

getDirectedEdgeDestination(edge)

Arguments

Value

the destination hexagon from the unidirectional edge H3Index.

Examples

getDirectedEdgeDestination(edge = c("115283473fffffff","16a2a1072b59ffff"))

Description

Get the origin cell of the unidirectional edge

Usage

getDirectedEdgeOrigin(edge)

Arguments

Value

the origin hexagon from the unidirectional edge H3Index.

Examples

getDirectedEdgeOrigin((edge = c("115283473fffffff","16a2a1072b59ffff")))

Description

Get the average hexagon area in square kilometers at the given resolution. Excludes pentagons.

Usage

getHexagonAreaAvgKm2(resolution)

Arguments

Value

Average hexagon area in square kilometers at the given resolution. Excludes pentagons.

Examples

getHexagonAreaAvgKm2(resolution = c(12L,10L))

Description

Get the average hexagon area in square meters at the given resolution. Excludes pentagons.

Usage

getHexagonAreaAvgM2(resolution)

Arguments

Value

Average hexagon area in square meters at the given resolution. Excludes pentagons.

Examples

getHexagonAreaAvgM2(resolution = c(12L,10L))

Description

Get the average hexagon edge length in kilometers at the given resolution. Excludes pentagons.

Usage

getHexagonEdgeLengthAvgKm(resolution)

Arguments

Value

Average hexagon edge length in kilometers at the given resolution. Excludes pentagons.

Examples

getHexagonEdgeLengthAvgKm(resolution = c(12L,10L))

Description

Get the average hexagon edge length in meters at the given resolution. Excludes pentagons.

Usage

getHexagonEdgeLengthAvgM(resolution)

Arguments

Value

Average hexagon edge length in meters at the given resolution. Excludes pentagons.

Examples

getHexagonEdgeLengthAvgM(resolution = c(12L,10L))

Description

Find all icosahedron faces intersected by a given H3 index. Faces are represented as integers from 0-19, inclusive. The array is sparse, and empty (no intersection) array values are represented by -1.

Usage

getIcosahedronFaces(cell)

Arguments

Value

list of vectors. Each list element corresponds to the input cell values. Each vector in a list element gives the faces intersected by the cell

Examples

getIcosahedronFaces(cell = c("8cbe63562a54bff","8cbe635631103ff"))

getIcosahedronFaces(cell = cellToParent(c("8cbe63562a54bff" ,"8cbe635631103ff"), c(7L, 7L)))

Description

Get the number of unique H3 indexes at the given resolution.

Usage

getNumCells(resolution)

Arguments

Value

the number of unique H3 indexes at the given resolution

Examples

getNumCells(resolution = c(12L,10L))

Description

Get all the pentagon H3 indexes at the specified resolution.

Usage

getPentagons(resolution)

Arguments

Value

all the pentagon H3 indexes at the specified resolution.

Examples

getPentagons(resolution = c(12L,10L))

Description

Get all the resolution 0 H3 indexes.

Usage

getRes0Cells()

Value

all the resolution 0 H3 indexes.

Examples

getRes0Cells()

Description

Returns the resolution of the index.

Usage

getResolution(cell)

Arguments

Value

a vector the same length as cell giving the resolution of each index

Examples

getResolution(cell = c("8cbe63562a54bff","8cbe635631103ff"))

Description

Gives the "great circle" or "haversine" distance between pairs of lat/lng coordinates in kilometers.

Usage

greatCircleDistanceKm(aLat, aLng, bLat, bLng)

Arguments

Value

numeric vector giving the great circle distance in kilometres

Examples

greatCircleDistanceKm(
  aLat = c(-37.820197)
  , aLng = c(144.983324)
  , bLat = c(-37.818476)
  , bLng = c(144.967354)
)

Description

Gives the "great circle" or "haversine" distance between pairs of lat/lng coordinates in meters.

Usage

greatCircleDistanceM(aLat, aLng, bLat, bLng)

Arguments

Value

numeric vector giving the great circle distance in metres

Examples

greatCircleDistanceM(
  aLat = c(-37.820197)
  , aLng = c(144.983324)
  , bLat = c(-37.818476)
  , bLng = c(144.967354)
)

Description

Gives the "great circle" or "haversine" distance between pairs of lat/lng coordinates in radians

Usage

greatCircleDistanceRads(aLat, aLng, bLat, bLng)

Arguments

Value

numeric vector giving the great circle distance in radians

Examples

greatCircleDistanceRads(
  aLat = c(-37.820197)
  , aLng = c(144.983324)
  , bLat = c(-37.818476)
  , bLng = c(144.967354)
)

Description

Get indices within k distance of the origin index.

Usage

gridDisk(cell, k)

Arguments

Details

Elements of the output array may be left as zero, which can happen when crossing a pentagon.

k-ring 0 is defined as the origin index, k-ring 1 is defined as k-ring 0 and all neighboring indexes, and so on.

Value

the indices within k distance of the origin index

Examples

gridDisk(cell = c("8cbe63562a54bff","8cbe635631103ff"), k = c(1L, 2L))

Description

Get indices within k distance of the origin index.

Usage

gridDiskDistances(cell, k)

Arguments

Details

k-ring 0 is defined as the origin index, k-ring 1 is defined as k-ring 0 and all neighboring indexes, and so on.

Value

indices within k distance of the origin index.

Examples

gridDiskDistances(cell = c("8cbe63562a54bff","8cbe635631103ff")
                 , k = c(1L, 2L))

Description

Provides the distance in grid cells between the two indexes.

Usage

gridDistance(origin, destination)

Arguments

Value

the grid distance between the two H3 cells

Examples

gridDistance(origin = c("85283473fffffff","85283473fffffff"),
             destination = c("8528342bfffffff","85283477fffffff"))

Description

Given two H3 indexes, return the line of indexes between them (inclusive).

Usage

gridPathCells(origin, destination)

Arguments

Details

This function may fail to find the line between two indexes, for example if they are very far apart. It may also fail when finding distances for indexes on opposite sides of a pentagon.

Value

the line of indexes between the two H3 cells

Examples

gridPathCells(origin = c("85283473fffffff","85283473fffffff")
              , destination = c("85283471fffffff","85283477fffffff"))

Description

Produces the hollow hexagonal ring centered at origin with sides of length k.

Usage

gridRingUnsafe(cell, k)

Arguments

Value

the indices of the hollow hexagonal ring centered at origin with sides of length k.

Examples

gridRingUnsafe(cell = c("8cbe63562a54bff","85283473fffffff"), k = c(2L, 1L))

Description

Returns non-zero if this index represents a pentagonal cell.

Usage

isPentagon(cell)

Arguments

Value

a vector the same length as cell indicating if the cell is Class II

Examples

isPentagon(cell = c("8cbe63562a54bff","8cbe635631103ff"))

Description

Returns non-zero if this index has a resolution with Class III orientation.

Usage

isResClassIII(cell)

Arguments

Value

a vector the same length as cell indicating if the cell is Class II

Examples

isResClassIII(cell = c("8cbe63562a54bff","8cbe635631103ff"))

hex8 <- "88bf4ac0cdfffff"
hex9 <- "89bf4ac0cd7ffff"
hex10 <- "8abf4ac0cd67fff"
isResClassIII(cell = c(hex8, hex9, hex10))

Description

Returns non-zero if this is a valid H3 cell index

Usage

isValidCell(cell)

Arguments

Value

a vector the same length as cell giving the validity of the cell

Examples

isValidCell(cell = c("8cbe63562a54bff","8cbe635631103ff", "abc", "3"))

Description

Determines if the provided H3Index is a valid unidirectional edge index.

Usage

isValidDirectedEdge(edge)

Arguments

Value

1 if it is a unidirectional edge H3Index, otherwise 0.

Examples

isValidDirectedEdge(edge = c("13d2a1672b34ffff","16a2a1072b59ffff"))

Description

Tests if the given vertex is a valid H3 vertex

Usage

isValidVertex(vertex)

Arguments

Value

returns 1 if the given index is a valid H3 vertex

Examples

isValidVertex(vertex = c("24cbe63562a549ff", "abc"))

Description

Indexes the location at the specified resolution, returning the index of the cell containing the location. This buckets the geographic point into the H3 grid

Usage

latLngToCell(lat, lng, resolution)

Arguments

Value

vector giving the H3 cell for each input lat/lng pair, at the given resolution

Examples

latLngToCell(
  lat = c(-37.820197, -37.818476)
  , lng = c(144.983324, 144.967354)
  , resolution = c(12, 12)
  )

Description

Produces an H3 index from local IJ coordinates anchored by an origin.

Usage

localIjToCell(origin, i, j)

Arguments

Value

cell vector of H3 cells

Examples

localIjToCell(
  origin = c("85283473fffffff","85283473fffffff")
  , i = c(1L, 2L)
  , j = c(2L, 1L)
 )

Description

Get all of the directed edges from an origin

Usage

originToDirectedEdges(origin)

Arguments

Value

a vector for each origin with all of the directed edges from the current H3Index

Examples

originToDirectedEdges(origin = c("85283473fffffff","8cbe635631103ff"))

Description

Returns the h3 indexes for the input GeoJSON-like data structure

Usage

polygonToCells(polygons, resolution, isLatLng = TRUE)

Arguments

Value

h3 indexes for the input GeoJSON-like data structure

Examples

## single polygon
polygon <- list(
  list(
  matrix(
    c(
    37.813318999983238, -122.4089866999972145,
    37.7198061999978478, -122.3544736999993603,
    37.8151571999998453, -122.4798767000009008
    )
    , ncol = 2
    , byrow = TRUE
  )
  )
)

polygonToCells(polygon, resolution = 7L)

## poylgon with a hole
polygon <- list(
list(
  matrix(
    c(
    37.813318999983238, -122.4089866999972145,
    37.7198061999978478, -122.3544736999993603,
    37.8151571999998453, -122.4798767000009008
    )
    , ncol = 2
    , byrow = TRUE
  ),
  matrix(
    c(
    37.813318999983238, -122.4089866999972145,
    37.7198061999978478, -122.3544736999993603,
    37.8151571999998453, -122.4498767000009008
    )
    , ncol = 2
    , byrow = TRUE
  )
)
)

polygonToCells(polygon, resolution = 7L)

## Many polygons
polygon <- list(
  list(
    matrix(
      c(
      37.813318999983238, -122.4089866999972145,
      37.7198061999978478, -122.3544736999993603,
      37.8151571999998453, -122.4798767000009008
      )
      , ncol = 2
      , byrow = TRUE
    )
   ),
 list(
  matrix(
    c(
    37.813318999983238, -122.4089866999972145,
    37.7198061999978478, -122.3544736999993603,
    37.8151571999998453, -122.4498767000009008
    )
    , ncol = 2
    , byrow = TRUE
    )
  )
)

polygonToCells(polygon, resolution = c(7L, 7L))

Description

Converts Radians to Degrees

Usage

radsToDegs(rad)

Arguments

Value

numeric vector giving the input rad values as degrees

Examples

radsToDegs(rad = seq(0, 2 * pi, by = (pi / 12) ) )

Description

A data set of train stations in Melbourne

Usage

stations

Format

stop_id

The ID of the station

stop_name

The name of the station

lat

The latitude coordinate of the station

lon

The longitude coordinate of the station

Details

Obtained from https://discover.data.vic.gov.au/dataset/gtfs-schedule and distributed under the Creative Commons 4 License https://creativecommons.org/licenses/by/4.0/

Description

This function uncompacts the provided set of compacted H3 cell indexes to the specified resolution.

Usage

uncompactCells(compactedSet, resolution)

Arguments

Value

a list of character vectors containing the uncompacted H3 cell indexes at the specified resolution

Examples

uncompactCells(
  compactCells(
    gridDisk(
      cell = c("85283477fffffff", "85283423fffffff")
      , k = c(1L, 2L)
     )
   )
   , res = c(5L, 5L)
 )

Description

Returns the latitude and longitude of the given vertex

Usage

vertexToLatLng(vertex)

Arguments

Value

data.frame of the lat/lng coordinates of the input vertex

Examples

vertices <- cellToVertex(
  cell = c(rep("8cbe63562a54bff", 6))
  , vertexNum = c(0L:5L)
  )

vertexToLatLng(vertex = vertices)