Computes summary timeseries in HS object — ensemble

Allows easy computation of summaries across runoff datasets with user defined functions. The functions provided are run either individually for, or across, each runoff/downscaled/discharge timeseries in an HS* object.

ensemble_summary(
  HS,
  summarise_over_timeseries = FALSE,
  aggregate_monthly = FALSE,
  funs = c("min", "mean", "median", "max"),
  drop = FALSE,
  ...,
  verbose = FALSE
)

Arguments

HS	`HS` object, or a list of data frames with column `Date`.
summarise_over_timeseries	Apply function(s) column-wise (to each timeseries separately, `TRUE`), or row-wise for each date in timeseries(`FALSE`, default).
aggregate_monthly	Return results as averages for the 12 months of the year? Defaults to `FALSE`.
funs	Functions to evaluate. By default, computes `min, mean, median and max`.
drop	Drop existing timeseries in `runoff_ts`, `discharge_ts`, or not.
...	Additional arguments passed to `funs`.
verbose	Indicate progress, or not. Defaults to `FALSE`.

Value

Returns the input HS object, or a list, where runoff/downscaled/discharge is replaced with the computed summaries.

Details

Applicable functions take a vector of numeric values as input, and return a single numerical value.