confirm.seasonalPeak: Confirm Seasonal Peak

In USGS-R/smwrStats: R functions to support statistical methods in water resources

Confirm Seasonal Peak

Description

Reviews/accepts the results of an analysis: method for "seasonalPeak" object.

Usage

## S3 method for class 'seasonalPeak'
confirm(x, all = FALSE, plot.only = FALSE, ...)

Arguments

x	a seasonalPeak object.
all	a logical value indicating whether to accept the peak without interactive user input or to force the user to process the peak. The default value is FALSE, forcing the user to process the peak. Can also be set to either 1 or 2, indicating the number of peaks.
plot.only	a logical value indicating that only a plot is desired. If TRUE, then x is returned invisibly and unchanged.
...	not used, required for compatibility with other methods.

Value

An object of class seasonalPeak. The confirmed object is a single value that represents the estimate of the timing of the peak and four or five aadditional ttributes.

NumPeaks: the number of seasonal peaks; either 1 or 2.
Models: candidate loading models. The number indicates the number of months of constituent loading.
hlife: candidate half-life values. The muner indicates the half-life in terms of months.
Confirmed: logical indicating that the object has not been confirmed.

If NumPeaks is 2, then an additional attirbute Second.peak that is a data frame of candidate parameters for the second peak is included. See seasonalWave for details.

References

Vecchia, A.V., Martin, J.D., and Gilliom, R.J., 2008, Modeling variability and trends in pesticide concentrations in streams: Journal of the American Water Resources Association, v. 44, no. 5, p. 1308-1324.

See Also

seasonalWave, seasonalPeak

Examples

## Not run: 
library(smwrData)
data(QW05078470)
# Simply click on the identified peak, and enter 1 for a single peak.
confirm(with(QW05078470, seasonalPeak(dectime(DATES), P00665)))

## End(Not run)

USGS-R/smwrStats documentation built on Oct. 11, 2022, 6:15 a.m.