generate_connectedness: Generate pairwise connectedness between patches using a...

View source: R/generate_connectedness.R

generate_connectednessR Documentation

Generate pairwise connectedness between patches using a numerical approximation to integrating over distances between areas within two patches

Description

Generate pairwise connectedness between patches using a numerical approximation to integrating over distances between areas within two patches

Usage

generate_connectedness(
  patches,
  connectedness_fun,
  max_distance = NULL,
  grid_resolution = 50,
  sparse = TRUE,
  centroid_distance = TRUE,
  verbose = 1L
)

Arguments

patches

a data frame containing polygons and indexes, such as that created by generate_patches

connectedness_fun

a vectorised function mapping distances to connectedness i.e. a spatial kernal (TODO: may also take a second argument giving the bearing)

max_distance

the maximum distance beyond which connectedness is assumed to be negligable - default is to determine this automatically

grid_resolution

the resolution of the numerical approximation, in terms of the number of points to evaluate betweeen zero distance and max_distance

sparse

should a sparse data frame be returned, or a dense matrix?

centroid_distance

should additional information of connectedness based on centroids be returned (ignored if !isTRUE(sparse))

verbose

verbosity level (0 is silent, 2 is noisy)


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