summary_boxcoef: summary_boxcoef. Summarise box coefficient pairs for multiple...

In USGS-R/sedReview: A package and shiny GUI for review of discrete water-quality sediment records and box coefficient exploration of data stored in the USGS NWIS system

Description

Function to summarise box coefficient pairs for multiple sites and years utilizing the find_boxcoef function

Usage

summary_boxcoef(
  x,
  timediff = 1,
  methods_NX = c(30, 40, 50, 55, 70, 100, 900, 920, 930, 940, 4033, 4080),
  methods_X = c(10, 15, 20),
  includeUV = FALSE,
  returnAllTables = FALSE
)

Arguments

x	A dataframe output from get_localNWIS
timediff	Number of hours to look before and after a point sample for a paired cross-section sample. Default is 1 (ie. look for a paired samples 1 hour before and 1 hour after a non-cross section/point sample timestamp)
methods_NX	Vector of Sampling Method (P82398) values that define non-cross section/point samples of the box coefficient. Default is: methods_NX = c(30,40,50,55,70,100,900,920,930,940,4033,4080) 30 (single vertical), 40 (multiple verticals), 50 (point sample), 55 (composite - multiple point samples), 60 (weighted bottle), 70 (grab sample - dip), 100 (Van Dorn), 900 (SS pumping), 920 (SS BSV DI att), 930 (SS partial depth), 940 (SS partial width), 4033 (suction lift peristaltic), 4080 (peristaltic pump). The option 'missing' can be added to include samples that have no associated sampling method for the record number, or a blank sampling method value
methods_X	Vector of Sampling Method (P82398) values that define cross section samples of the box coefficient. Default is: methods_X = c(10,15,20) 10 (EWI), 15 (multiple verticals non-isokinetic EWT), or 20 (EDI). The option 'missing' can be added to include samples that have no associated sampling method for the record number, or a blank sampling method value
includeUV	Logical. If x was returned from get_UVflow, run optional addition of available Approved Unit Value discharge to output table. Default is FALSE.
returnAllTables	Logical. If TRUE, return a list with the summary table and all individual site tables from the find_boxcoef function used internally. Default is FALSE.

Details

Function summarises box coefficient pairs by each site and WY. See documentation for find_boxcoef function for more details.

Value

A dataframe of the summary counts of box coefficient pairs, or a list of the summary and individual site box_coef data

See Also

get_localNWIS, find_boxcoef, get_UVflow

Examples

data('exampleData2', package = "sedReview")
x <- exampleData2
boxCoef <- summary_boxcoef(x)
boxCoef_list <- summary_boxcoef(x, returnAllTables = TRUE)
## Not run: 
View(boxCoef_list$summary)

## End(Not run)

USGS-R/sedReview documentation built on Aug. 24, 2020, 9 p.m.