fill_akqenv: Fill an R Environment with Asquith-Knight Discharge Decay...

In wasquith-usgs/akqdecay: Many Distributional Statistics of USGS Daily Streamflow Hydrographs and Powerful Utilities

Description

Compute Asquith–Knight discharge decay analyses for a succession of USGS streamgage identification numbers in an R environment from fill_dvenv and populates (fills) with output from akqdecay as another R environment. This function is intended to be used just ahead of extraction functions such as akq_counts, akq_lmom, and akq_summary.

Usage

fill_akqenv(sites=NULL, dvenv=NULL, envir=NULL, silent=FALSE, ...)

Arguments

sites	An optional, likely partial, list of sites within dvenv for population into envir. This option means that a massive environment of daily values can be retained in the user's space but Asquith–Knight discharge decay analyses can be restricted to a smaller subset of sites. If sites=NULL, then internally all of the sites within dvenv will be processed, and this would be almost universally the way to use this function;
dvenv	An R environment previously populated by fill_dvenv;
envir	A user created (usually) R environment by new.env();
silent	Suppress informative calls to message(); and
...	Additional arguments to pass to control akqdecay.

Value

This function is used for its side effects on the envir argument but does return a count of the sites processed by akqdecay.

Author(s)

W.H. Asquith

See Also

akqdecay, fill_dvenv, akq_summary, fill_akqenv_parallel

Examples

## Not run: 
# See fill_dvenv() Examples for the creation of wolf.env used here.
akqwolf.env <- new.env() # the standard declaration of an environment
fill_akqenv(dvenv=wolf.env, envir=akqwolf.env) #
## End(Not run)

wasquith-usgs/akqdecay documentation built on Nov. 9, 2020, 1:13 p.m.