ww_wymUSGS: Water Year & Monthly Stats (USGS)

In joshualerickson/whitewater: Parallel Processing Options for Package 'dataRetrieval'

Water Year & Monthly Stats (USGS)

Description

This function uses the results of the ww_dvUSGS object to generate mean, maximum, median, standard deviation and coefficient of variation per water year per month.

Usage

ww_wymUSGS(procDV, sites = NULL, parallel = FALSE, verbose = TRUE, ...)

Arguments

procDV	A previously created ww_dvUSGS object.
sites	A character vector with NWIS site numbers (optional).
parallel	logical indicating whether to use future_map().
verbose	logical for printing information. TRUE (default).
...	arguments to pass on to future_map and ww_dvUSGS.

Value

A tibble filtered by water year and month with added meta-data.

Note

If a previously created ww_dvUSGS object is not used then the user needs to provide a sites vector. This will run ww_dvUSGS in the background.

Examples

## Not run: 

library(whitewater)
yaak_river_dv <- ww_dvUSGS('12304500',
parameter_cd = '00060',
wy_month = 10)

yaak_river_wym <- ww_wymUSGS(yaak_river_dv)


## End(Not run)

joshualerickson/whitewater documentation built on July 1, 2024, 10:14 p.m.