summary.hydromad {hydromad} | R Documentation |
Assess and summarise performance of Hydromad models.
## S3 method for class 'hydromad' summary(object, breaks = NULL, stats = hydromad.getOption("summary.stats"), with.hydrostats = TRUE, na.action = na.exclude, ...) ## S3 method for class 'hydromad.runlist' summary(object, with.hydrostats = FALSE, ...)
object |
an object of class |
breaks |
if specified, break up the time series and calculate statistics for each chunk.
Can be a vector of cut points or number of intervals to cut
into or an interval specification, one of "sec", "min",
"hour", "day", "DSTday", "week", "month" or "year", optionally
preceded by an integer and a space, or followed by "s".
See |
stats |
which performance statistics to compute. The definitions are looked
up by name in |
with.hydrostats |
to also include |
na.action |
an optional function to apply to the data to treat missing values before calculating statistics. |
... |
ignored. |
Definitions of statistics are looked up by name in
hydromad.stats()
, and you can also use that
function to add new statistics.
summary
returns a list with named entries for each of the
chosen stats (stats
). When breaks
is given it retuns a
zoo
object of class "summaryWithBreaks"
.
Felix Andrews felix@nfrac.org
hydromad.stats
,
objFunVal
for a way to calculate statistic values directly;
hydromad.object
data(HydroTestData) mod0 <- hydromad(HydroTestData, sma = "scalar", routing = "expuh", tau_s = 10) mod0 summary(mod0) summary(mod0, breaks = "months") #summary(mod0, breaks = 3) allstats <- names(hydromad.stats()) summary(mod0, stats = allstats) objFunVal(mod0, hmadstat("r.sq.log")) str(objFunVal(mod0, hydromad.stats()))