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

Description Usage Arguments Value See Also Examples

Description

Produce a 1-row data.frame of model metrics. The relevant metrics for loadReg2 models are largely the same as those reported by the rloadest package, though reported in this streamlined data.frame format for bulk reporting. summarizeModel.loadReg2 should rarely be accessed directly; instead, call summarizeModel() on a loadReg2 object.

Usage

1
2
## S3 method for class 'loadReg2'
summarizeModel(load.model, ...)

Arguments

load.model

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

...

Other arguments passed to model-specific methods

Value

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

See Also

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

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Not run: 
library(rloadest)
no3_lr <- suppressWarnings(
  loadReg2(loadReg(NO3 ~ model(9), data=get(data(lamprey_nitrate)),
  flow="DISCHARGE", dates="DATE", time.step="instantaneous", 
  flow.units="cfs", conc.units="mg/L", load.units="kg",
  station='Lamprey River, NH')))
summarizeModel(no3_lr)

## End(Not run)

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