st_bridges {sfislands} | R Documentation |
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,
row_identifier,
remove_islands = FALSE,
link_islands_k = 1,
nb_structure = "list",
add_to_dataframe = TRUE,
threshold = 1.001,
geom_col_name = lifecycle::deprecated()
)
Arguments
df |
an 'sf' or 'sfc' object. |
row_identifier |
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. |
threshold |
default 1.001. factor by which to change the size of buffer automatically generated around islands to account for imprecisions which may arise from sf::st_buffer() functionality. This can be increased if connections to islands are not occurring as expected. |
geom_col_name |
name of a column from 'df' containing names (or unique identifiers) for each row. This argument is now deprecated and the new "row_identifier" argument replaces it with the same functionality. |
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")