flexFN: Flexible Flow Normalization

Description Usage Arguments Value Examples

View source: R/flexFN.R

Description

This function implements generalized flow normalization. This means that for determining the flow normalized concentration and flow normalized flux for any given year, there is a specified list of years from which to create the discharge record used in the flow-normalization process. That set of years is defined by the dateInfo object.

Usage

1
2
3
flexFN(eList, dateInfo, localsurfaces = NA, oldSurface = FALSE,
  flowNormStartCol = "flowNormStart", flowNormEndCol = "flowNormEnd",
  flowStartCol = "flowStart", flowEndCol = "flowEnd")

Arguments

eList

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

dateInfo

data frame with 4 columns. The column names and descriptions are described below. Default is NA.

localsurfaces

surface (3-dimensional matrix) over-riding the one stored in eList Default = NA.

oldSurface

logical, if TRUE, use the surface object in eList. Default is FALSE.

flowNormStartCol

character, name of the column in dateInfo that starts the segment for the flow normalization

flowNormEndCol

character, name of the column in dateInfo that ends the segment for the flow normalization

flowStartCol

character, name of the column in dateInfo that starts the segment for the portion of the flow to be populated with flow-normalized values.

flowEndCol

character, name of the column in dateInfo that ends the segment for the portion of the flow to be populated with flow-normalized values.

Value

named list, eList, containing INFO, Daily, Sample, and surfaces objects

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
eList <- Choptank_eList
eList <- setUpEstimation(eList)
flowNormStart <- c("1979-10-01","1990-01-01","1992-10-10")
flowNormEnd <- c("1995-06-06","2004-03-03","2011-09-29")
flowStart <- c("1979-10-01","1995-06-07","2004-03-04")
flowEnd <- c("1995-06-06","2004-03-03","2011-09-29") 
dateInfo <- data.frame(flowNormStart,
                       flowNormEnd,
                       flowStart, 
                       flowEnd, 
                       stringsAsFactors = FALSE)

newEList <- flexFN(eList, dateInfo)
plotFluxHist(newEList)
flexPlotAddOn(newEList)

wallSurface <- estSurfaces(eList, localSample = eList$Sample[1:500,])
wallEList <- flexFN(eList, dateInfo, localsurface = wallSurface)
plotFluxHist(wallEList)

EGRET documentation built on Jan. 25, 2022, 5:08 p.m.