applyDAR: Apply two version of Drainage Area Ratio

Description Usage Arguments Details Value

View source: R/applyDAR.R

Description

The function applyDAR conducts a cross-validated evaluation of nearest-neighbor and map-correlation drainage area ratio.

Usage

1
2
applyDAR(listofgages, startDate, endDate, limWY = 1, limDAR = c(-Inf, Inf),
  cv = list(fold = NA, dense = TRUE), flowStat = FALSE)

Arguments

listofgages

A dataframe of sites to be used for analysis. Sites are character strings with at least 8 numeric characters.

startDate

Specifies a particular date from which to begin retrieving the streamflow data. Format should be "YYYY-MM-DD". If blank, all available data will be retrieved.

endDate

Specifies a particular date up to which to retrieve the streamflow data. Format should be "YYYY-MM-DD". If blank, all available data will be retrieved.

limWY

(optional) The minimum number of water years required for a site to be included. The default is 1.

limDAR

(optional) A numeric vector with two elements, indicating the minimum and maximum drainage area ratio to be allowed for the applicaiton of drainage area ratio. The default is c(-Inf,Inf).

cv

(optional) A list of two elements defining the parameters of cross validation.

  • foldAn integer indicating how many folds should be used for evaluation. The default, NA or 1, requests a leave-one-out analysis.

  • denseA logical value indicating if the smaller or larger half of the cross-validation fold should be used as the index. The defulat, TRUE, calls for the dense scenario using the larger half of the fold as the index network.

flowStat

(optional) A logical indicating if the streamflow statistics should be evaluated. This will increase run time. The default is FALSE.

Details

Lorem ipsum...

Value

A list of two elements:

cvList

Corss-validated estiamted and observed streamflows.

anList

basic analysis of estiamted streamflows.


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