getFlowStats: Collect the estiamted and observed streamflow statistics.

Description Usage Arguments Details Value

View source: R/getFlowStats.R

Description

The function getFlowStats collects a wide array of streamflow statistics for observed and modeled streamflow time series.

Usage

1
2
getFlowStats(modelOutput, zero.val = 0.001, cens.level = 0.005,
  min.obs = 0.01)

Arguments

modelOutput

A list of model results, in the format returned by estDAR or estQPPQ.

zero.val

(optional) The censoring value used to indicate a censored streamflow value. The default is 0.001.

cens.level

(optional) The value below which a streamflow value is considered censored. (Rounded down rather than up.) The default is 0.005.

min.obs

(optional) The minimum non-censored value of streamflow. The default is 0.01.

Details

See calcFlowStats for a list of statistics calculated.

Value

A list of two elements:

Obs

A data frame of streamflow statistics derived from observed time series.

Est

A data frame of streamflow statistics derived from estimated time series.


wfarmer-usgs/PUBAD documentation built on May 4, 2019, 5:21 a.m.