calc_magnifSeven: Function to return the magnificent seven statistics for a...

View source: R/calc_magnifSeven.r

calc_magnifSevenR Documentation

Function to return the magnificent seven statistics for a given data series

Description

Function to return the magnificent seven statistics for a given data series

Usage

calc_magnifSeven(x, yearType = "water", wyMonth = 10L, digits = 3)

Arguments

x

A dataframe containing a vector of date values in the first column and vector of numeric flow values in the second column.

yearType

A charcter of either "water" or "calendar" indicating whether to use water years or calendar years, respectively.

wyMonth

A numeric. The month of the year in which the water year starts (1=January, 12=December). The water year begins on the first day of wyMonth.

digits

A numeric. Number of digits to round indice values

Details

This is a function to compute the 7 statistics of daily streamflow used by Archfield et al., under revision (June 2013).

Value

data.frame of calculated statistics

Examples

x<-sampleData[c("date","discharge")]
magSeven <- calc_magnifSeven(x)

USGS-R/EflowStats documentation built on Sept. 30, 2023, 9:31 p.m.