summarizeModel.loadComp: Extract model summary statistics from a loadComp model

Description Usage Arguments Value See Also

Description

Produce a 1-row data.frame of model metrics. The relevant metrics for loadComp models include two sets of statistics about autocorrelation (one for the regression residuals, one for the 'residuals' used to do the composite correction).

Usage

1
2
3
## S3 method for class 'loadComp'
summarizeModel(load.model, newdata,
  irregular.timesteps.ok = NA, ...)

Arguments

load.model

A load model object, typically inheriting from loadModel and always implementing the loadModelInterface.

newdata

data.frame of data that was/will be used to predict concentration or load; should be the same as the newdata argument to predictSolute, e.g. a data.frame of daily or instantaneous dates and discharges.

irregular.timesteps.ok

logical. If FALSE, this function requires that the timesteps between observations are identical to one another, and a plot is generated and an error is thrown if this requirement is not met. If TRUE, the check is not performed. If NA (the default), the check is performed but the function proceeds with a warning and no plot if the timesteps are found to be irregular. Tests and estimates of autocorrelation are weak to wrong when timesteps are irregular, but timesteps are often at least a bit irregular in the real world.

...

Other arguments passed to model-specific methods

Value

Returns a 1-row data frame with the following columns:

See Also

Other summarizeModel: summarizeModel.loadInterp, summarizeModel.loadLm, summarizeModel.loadModel, summarizeModel.loadReg2, summarizeModel


McDowellLab/loadflex documentation built on May 8, 2019, 9:48 a.m.