fvcom_nodes: Retrieve node locations

View source: R/nc.R

fvcom_nodesR Documentation

Retrieve node locations

Description

Retrieve node locations

Usage

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

Arguments

x

FVCOM ncdf4 object

what

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

index

NULL or numeric, a 1-based index of desired nodes. If NULL then all nodes are returned

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 of the indices of the neighbors

  • art1 Area of elements around a node

  • art2 Area of Node-Base Control volume

Value

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

  • node node 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.