res_area {h3jsr}

Get average cell area

Description

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

Usage

res_area(res = NULL, units = c("m2", "km2"), fast = TRUE)

Arguments

res

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

units

Areal unit to report in. Options are square meters or square kilometers.

fast

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

Value

Numeric; average H3 cell area.

Examples

# Return average H3 cell area at each resolution in square meters
res_area(res = seq(0, 15), units = 'm2')