updist_sites {SSNbler} | R Documentation |
Get upstream distance for sites in a Landscape Network (LSN)
updist_sites(
sites,
edges,
length_col,
lsn_path,
save_local = TRUE,
overwrite = TRUE
)
sites |
A named list of one or more |
edges |
An |
length_col |
The name of the column in |
lsn_path |
Local pathname to a directory in
character format specifying where the LSN resides, which is
created using |
save_local |
Logical indicating whether the updated
|
overwrite |
A logical indicating whether results should be
overwritten if the upDist column already exists in #' @details Upstream distances are measured in the map projection units for the
The upstream distances stored in |
One or more sf
object(s) with all the original
data from sites
, along with a new upDist
column in
each sites sf
object. A named list is returned. If
save_local = TRUE
, a GeoPackage for each sf
object
is saved in lsn_path
. Output file names are assigned based
on the input sites
attribute names
.
# Get temporary directory, where the example LSN will be stored
# locally.
temp_dir <- tempdir()
# Build the LSN. When working with your own data, lsn_path will be
# a local folder of your choice rather than a temporary directory.
edges<- lines_to_lsn(
streams = MF_streams,
lsn_path = temp_dir,
snap_tolerance = 1,
check_topology = FALSE,
overwrite = TRUE,
verbose = FALSE
)
# Incorporate observed sites, MF_obs, into LSN
obs<- sites_to_lsn(
sites = MF_obs,
edges = edges,
save_local = FALSE,
snap_tolerance = 100,
overwrite = TRUE,
verbose = FALSE
)
# Incorporate prediction dataset, MF_preds, into LSN
preds<- sites_to_lsn(
sites = MF_preds,
edges = edges,
save_local = FALSE,
snap_tolerance = 1,
overwrite = TRUE,
verbose = FALSE
)
# Calculate upstream distance for edges
edges<- updist_edges(
edges = edges,
lsn_path = temp_dir,
calc_length = TRUE,
length_col = "Length",
overwrite = TRUE,
save_local = FALSE,
verbose = FALSE
)
# Calculate upstream distance for observed sites (obs) and one
# prediction dataset (preds)
site.list<- updist_sites(
sites = list(obs = obs,
preds = preds),
edges = edges,
length_col= "Length",
lsn_path = temp_dir,
save_local = FALSE,
overwrite = TRUE
)
# Summarize the new column upDist in obs
summary(site.list$obs$upDist)
# Summarize the new column upDist in preds
summary(site.list$preds$upDist)