random_point: Generate listing of one or more random points

View source: R/FVCOMPhysics.R

random_pointR Documentation

Generate listing of one or more random points

Description

Generate listing of one or more random points

Usage

random_point(
  X,
  n = 1,
  select_time = c("first", "last", "random")[1],
  select_z = c("random", "surface", "bottom")[1],
  zvar = c("siglev", "siglay")[1]
)

Arguments

X

FVCOM_Physics object

n

numeric the number of random points to generate

select_time

character, one of 'first' (default), 'last' or 'random'

select_z

numeric or character. If character then 'random' (default), 'surface', 'bottom'. If numeric then you specify your own in zvar units. If numeric then the user must provide 1 (recycled across all points) or n values.

zvar

character, the name of the varoiable to use for z locations

Value

sf POINT XYZ object with n features


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