calcEmpFDCs: Calculate empirical FDCs for all sites

Description Usage Arguments Details Value

View source: R/calcEmpFDCs.R

Description

The function nse computes the Nash-Sutcliffe efficiency for the rows or columns of a matrix.

Usage

1
2
3
4
5
calcEmpFDCs(flow_data, quant.type = 9, cens = "unfilled",
  cens_level = 0.005, begWyr = 1900, endWyr = 2014, saveName = "",
  FDC.probs = c(2e-04, 5e-04, 0.001, 0.002, 0.005, 0.01, 0.02, 0.05, 0.1, 0.2,
  0.25, 0.3, 0.4, 0.5, 0.6, 0.7, 0.75, 0.8, 0.9, 0.95, 0.98, 0.99, 0.995, 0.998,
  0.999, 0.9995, 0.9998))

Arguments

flow_data

A zoo object of streamflow data.

quant.type

(optional) An integer, from 1 to 9, defining the formula used to compute quantiles. The default is 9.

cens

(optional) A character string, either 'filled' or 'unfilled', specifying how censored values will be handled. The default is 'unfilled'.

cens_level

(optional) The number specifying the censoring level. The default is 0.005.

begWyr

(optional) The lower limit of water years to consider. The default is 1900.

endWyr

(optional) The upper limit of water years to consider. The default is 2014.

saveName

(optional) A character string of a file name, without extension, in which to save results. An empty string, the default, requests that nothing be saved.

FDC.probs

(optional) THe probabilities of the quantiles to be calculated. The default is c(0.0002,0.0005,0.001,0.002,0.005,0.01, 0.02,0.05,0.10,0.20,0.25,0.30,0.40,0.50,0.60,0.70,0.75,0.80,0.90,0.95, 0.98,0.99,0.995,0.998,0.999,0.9995,0.9998).

Details

This function computes flow duration curves and summary statistics for a given time series (aka zoo object) of stream flows. It outputs the FDCs directly, but can also write to external files via saveName.

If cens is set to 'filled', library(smwrQW) is required. (Install via instructions found here: https://github.com/USGS-R/smwrQW as the package is not on CRAN.)

Value

A large list of many internal parameters. The most salient are:

empFDC

A matrix of the empircal flow duration curve quantiles.

PORstats.compWyr

The number of complete water years available at each site.


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