st_bridges {sfislands}

Create first-order queen contiguity neighbourhood structure with additional connections when islands are present, ensuring that there are no unconnected units

Description

Create first-order queen contiguity neighbourhood structure with additional connections when islands are present, ensuring that there are no unconnected units

Usage

st_bridges(
  df,
  geom_col_name,
  remove_islands = FALSE,
  link_islands_k = 1,
  nb_structure = "list",
  add_to_dataframe = TRUE
)

Arguments

df

an 'sf' or 'sfc' object.

geom_col_name

name of a column from 'df' containing names (or unique identifiers) for each row.

remove_islands

default 'FALSE'. Whether or not to omit islands from contiguity construction.

link_islands_k

an integer, k. The number of nearest units to which each island should be connected.

nb_structure

default '"list"'. Can also be '"matrix"'. The format in which to return the named contiguity structure.

add_to_dataframe

default 'TRUE'. Whether or not to augment existing df with contiguity output as '"nb"' column. 'FALSE' returns only the contiguity structure.

Value

Either a named neighbourhood list or matrix, or an 'sf' dataframe with list or matrix included as '"nb"' column.

Examples

st_bridges(uk_election,"constituency_name")