res_length {h3jsr}

Get average cell edge length

Description

This function returns the average edge length of an H3 cell edge at a given resolution.

Usage

res_length(res = NULL, units = c("m", "km"), fast = TRUE)

Arguments

res

Integer; Desired H3 resolution. See https://h3geo.org/docs/core-library/restable/ for allowable values and related dimensions.

units

Length unit to report in. Options are meters or kilometers.

fast

Logical; whether to retrieve values from a locally stored table or recalculate from source.

Value

Numeric; H3 cell edge length

Note

This value is also the hexagon circumradius.

Examples

# Return average H3 cell edge length at each resolution in kilometers
res_length(res = seq(0, 15), units = 'km')