dot-sim_once: Generate a Single Simulation of Tidal Deviations
In ccb60/SLRSIM: Tools to Analyse Sea Level Rise

Description Usage Arguments Details Value See Also

Simulates a single random time series, based on an ARIMA model. Can accept regression parameters as well, usually Year and an annual (season) fourier decomposition. terms

.sim_once(
  .data,
  .dt,
  .predicted,
  .model,
  .slr,
  .fldlvl,
  .wl_update = 0,
  .len = NULL
)

`.data`	A source data frame. can be NULL if .dt and .wl are defined in the enclosing environment.
`.dt`	Dates and times. A data column in .data or a data vector defined in the enclosing environment that contains date-time information. Must inherit from POSIXct.
`.predicted`	The (astronomical) tidal predictions. A numerical data column in .data or a numerical vector defined in the enclosing environment.
`.model`	a time series model with a suitable `simulate()` method, usually an ARIMA model model of `class = c("ARIMA")`.
`.slr`	Sea level rise estimate. A numeric vector containing one or more values. What sea level rise scenarios should the analysis be based on? Selection of appropriate sea level rise estimates should be based on your time horizon and risk tolerance. NOAA forecasts of SLR for 2100 vary from 0.3 (almost certain) to 2.5 (highly unlikely) meters.
`.fldlvl`	Flood level. A single numeric value, that defines what constitutes a flood event. Must be specified in `floodcast_tub()`. In `floodcast_tub_lookup()`, will default to the "Highest Astronomical Tide" elevation, or HAT for the selected tide station.
`.wl_update`	A single numeric value that adjusts for any changes in sea level from the tidal epoch to the present day.
`.len`	Desired length of simulated output. IF `NULL`, defaults to the length of the input deviations.