print.seasonalPeak: Print Objects

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

Print Objects

Description

Prints the results of a seasonal peak analysis (seasonalPeak).

Usage

## S3 method for class 'seasonalPeak'
print(x, digits = 3, details = FALSE, ...)

Arguments

x	an object of class "seasonalPeak" from seasonalpeak.
digits	the number of significant digits to print numeric data.
details	logical, print the model details?
...	not used for method, required for other methods.

Value

The object x is returned invisibly.

Note

The printed output contains the default time-of-peak value and potential alternate values for unconfirmed peaks and the number of peaks, timing of the primary peak, and optionally the model information for confirmed peaks.

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