getQuantiles: Summarizes EverForecast simulations.

View source: R/getQuantiles.R

getQuantilesR Documentation

Summarizes EverForecast simulations.

Description

Generates a dataframe of daily EverForecast quantiles for each point/region of interest (where population is the mean water depth on a given day in n EverForecast simulations).

Usage

getQuantiles(
  traceDataLong,
  ROI_names = paste0(unique(traceDataLong$name), collapse = "|"),
  quantiles = c(0.1, 0.25, 0.5, 0.75, 0.9)
)

Arguments

traceDataLong

Lightly processed EverForecast simulation data, found in the traceDataLong object returned by RSM::extractSimData(). RSM::extractSimData() needs to be run for this function to be used.

ROI_names

grep-style character vector used to select a subset of the targetLocations in the input in the traceDataLong object.

quantiles

percentiles to include in output. For example, 0.5 would return the 50th percentile (median value from x simulations) for each day in the EverForecast simulations and for each region of interest identified in ROI_names

Value

list getQuantiles returns a long dataframe with one row per date, region of interest, and quantile

Examples

getQuantiles
## Not run: 



troyhill/EvergladesEBM documentation built on Nov. 19, 2023, 8:39 a.m.