utilMWRsumfun: Verify summary function

In massbays-tech/MassWateR: Quality Control and Analysis of Massachusetts Water Quality Data

Verify summary function

Description

Verify summary function

Usage

utilMWRsumfun(accdat, param, sumfun = "auto")

Arguments

accdat	data.frame for data quality objectives file for accuracy as returned by readMWRacc
param	character string for the parameter to evaluate as provided in the "Parameter" column of "accdat"
sumfun	character indicating one of "auto" (default), "mean", "geomean", "median", "min", or "max", see details

Details

This function verifies appropriate summary functions are passed from sumfun. The mean or geometric mean output is used for sumfun = "auto" based on information in the data quality objective file for accuracy, i.e., parameters with "log" in any of the columns are summarized with the geometric mean, otherwise arithmetic. Using "mean" or "geomean" for sumfun will apply the appropriate function regardless of information in the data quality objective file for accuracy.

Value

Character indicating the appropriate summary function based on the value passed to sumfun.

Examples

# accuracy path
accpth <- system.file('extdata/ExampleDQOAccuracy.xlsx', 
     package = 'MassWateR')

# accuracy data
accdat <- readMWRacc(accpth)

# geomean auto
utilMWRsumfun(accdat, param = 'E.coli')

# mean force
utilMWRsumfun(accdat, param = 'E.coli', sumfun = 'mean')

# mean auto
utilMWRsumfun(accdat, param = 'DO')

# geomean force
utilMWRsumfun(accdat, param = 'DO', sumfun = 'geomean')

massbays-tech/MassWateR documentation built on April 12, 2025, 7:53 p.m.