fvcom_elems: Retrieve element locations

View source: R/nc.R

fvcom_elemsR Documentation

Retrieve element locations

Description

Retrieve element locations

Usage

fvcom_elems(
  x,
  what = c("lonlat", "xy")[1],
  index = NULL,
  form = c("table", "sf"),
  include = "none"
)

Arguments

x

FVCOM ncdf4 object

what

character, either 'lonlat' (degrees) or 'xy' (meters)

index

numeric, a 1-based index of desired nodes

form

character either 'table' or 'sf'

include

character or NULL items to add to the returned data. Multiple items can be included, but note that "none" is the same as NULL so nothing gets included.

  • none don't include any extra information - same as setting to NULL

  • nbs include a list other element-wise information. If not 'none“ then consider 'nv' for indices of neighbor nodes and/or 'nbe' for indices of neighbor elements

Value

data frame (tibble) of element locations including...

  • elem element index identifier

  • lon (or x) locations value

  • lat (or y) location value

Or a sf collection of type POINT


BigelowLab/fvcom documentation built on Nov. 8, 2024, 2:24 p.m.