setUpEstimation: setUpEstimation

View source: R/modelEstimation.R

setUpEstimationR Documentation

setUpEstimation

Description

Set up the INFO data frame for a modelEstimation

Usage

setUpEstimation(eList, windowY = 7, windowQ = 2, windowS = 0.5,
  minNumObs = 100, minNumUncen = 50, edgeAdjust = TRUE, verbose = TRUE,
  interactive = NULL)

Arguments

eList

named list with at least the Daily, Sample, and INFO dataframes

windowY

numeric specifying the half-window width in the time dimension, in units of years, default is 7

windowQ

numeric specifying the half-window width in the discharge dimension, units are natural log units, default is 2

windowS

numeric specifying the half-window with in the seasonal dimension, in units of years, default is 0.5

minNumObs

numeric specifying the miniumum number of observations required to run the weighted regression, default is 100

minNumUncen

numeric specifying the minimum number of uncensored observations to run the weighted regression, default is 50

edgeAdjust

logical specifying whether to use the modified method for calculating the windows at the edge of the record. The modified method tends to reduce curvature near the start and end of record. Default is TRUE.

verbose

logical specifying whether or not to display progress message

interactive

logical deprecated. Use 'verbose' instead

Value

eList named list with Daily, Sample, and INFO dataframes.

Examples

eList <- Choptank_eList
eList <- setUpEstimation(eList)


USGS-R/EGRET documentation built on Feb. 9, 2024, 5:30 p.m.