setup_structures: Setup structures for bathtub inundation modeling

View source: R/setup_structures.R

setup_structuresR Documentation

Setup structures for bathtub inundation modeling

Description

Setup structures for bathtub inundation modeling

Usage

setup_structures(
  structures,
  type = "depth",
  invert,
  invert_units = "ft",
  elev = NA,
  elev_units = "m",
  vdatum = "NAVD88",
  null_value = 99,
  other_cols = NULL,
  workspace
)

Arguments

structures

A sf object denoting stormwater structures

type

Type of invert survey data. 'depth', 'elevation', or 'none'

invert

Name of column denoting invert survey data

invert_units

Units of invert elevation data

elev

Name of column denoting surface elevation of stormwater structure, or RasterLayer NAVD88 DEM to extract elevation from

elev_units

Units of elev values

vdatum

Vertical datum of elevation data (only NAVD88 supported)

null_value

Invert survey data value indicating missing data

other_cols

Other columns to preserve

workspace

Path to bathtub folder

Value

An sf object denoting structures formatted with units

Examples

# structures_n <-
# setup_structures(
#   structures = structures,
#   type = "elevation",
#   invert = "INVERTELEV",
#   elev = "Elevation",
#   elev_units = "ft",
#   null_value = 99,
#   other_cols = c("Code","Prcnt_Obst","Type_Obst"),
#   workspace = workspace
# )

acgold/floodr documentation built on Aug. 30, 2022, 11:17 a.m.