generate_patches: Generate hexagons (patches) within a user-specified landscape

In ku-awdc/HexScape: Aggregation of Spatial Data into Discrete Patches using Simple Features

Generate hexagons (patches) within a user-specified landscape

Description

Generate hexagons (patches) within a user-specified landscape

Usage

generate_patches(
  landscape,
  hex_width,
  name = "patch",
  name_index = TRUE,
  reference_point = st_point(c(0, 0)),
  land_use = NULL,
  add_removed = FALSE,
  min_prop = 0.01,
  simplify_keep = 0.1
)

Arguments

landscape	spatial information for the area to convert into hexagons (an sfc object) - this may be a simple polygon, or a more complex sfc object containing different land types to be classified according to the land_use argument
hex_width	the width of the hexagons
name	a name for the landscape - this is used for caching, and is also useful when combining different landscapes together at a later point
name_index	should the name of the landscape be prepended to the patch indices? This facilitates combining different landscapes together at a later point. Otherwise, the patch index will be a number.
reference_point	the coordinate for the centre of the patch with row (r) 0 and column (q) 0. This need not be within the landscape specified. In order to combine landscapes together, each must have been generated using an identical reference_point.
land_use	an optional data frame of categorisations for different land types in the landscape (TODO: expand help)
add_removed	option to crate a patch with index NA containing all of the parts of the landscape that have been removed due to consisting of impassable land types. May be useful for visualising an entire landscape.
min_prop	the minimum size of a patch to retain relative to the area of a "full hexagon". This can be adjusted to remove small fragments of patches e.g. along coastlines.
simplify_keep	passed on to ms_simplify

Examples

xrange <- c(0, 50)
yrange <- c(0, 50)
corners <- tibble::tribble(~x, ~y,
    xrange[1], yrange[1],
    xrange[2], yrange[1],
    xrange[2], yrange[2],
    xrange[1], yrange[2],
    xrange[1], yrange[1]
)
landscape <- sf::st_sfc(sf::st_multipolygon(list(list(as.matrix(corners)))))
## And add our hexagons:
patches <- generate_patches(landscape, hex_width=2)
patches
ggplot(patches) + geom_sf() + theme_void()
ggplot(patches %>% filter(r %in% 0:3, q %in% 0:3), aes(label=Index)) + geom_sf() + geom_sf_text()

ku-awdc/HexScape documentation built on Jan. 10, 2025, 5:24 p.m.