summaryStats: Summary stats function

Description Usage Arguments Examples

View source: R/summaryStats.R

Description

Takes output data object from readNWISodbc and generates a table of summary statistcs

Usage

1
2
summaryStats(qw.data, STAIDS = NULL, parameterCd = NULL,
  begin.date = NA, end.date = NA)

Arguments

qw.data

A qw.data object generated from readNWISodbc

STAIDS

A character vector of sites to summarize. Defaults to all sites in qw.data if unspecified.

parameterCd

A character vector of parameter codes to summarize. Defaults to all pcodes if unspecified.

begin.date

A character string of optional begin date range to summarize over in "YYYY-MM-DD" format. Defaults to all if unspecified.

end.date

A character string of optional end date range to summarize over in "YYYY-MM-DD" format. Defaults to all if unspecified.

Examples

1
2
3
4
5
6
data("exampleData",package="WQReview")
summaryStatsOut <- summaryStats(qw.data = qw.data,
             STAIDS="06733000", 
             parameterCd = c("00095","00915","00945"), 
             begin.date = "2010-01-01", 
             end.date = "2011-12-31")

USGS-R/WQ-Review documentation built on Nov. 12, 2019, 9:51 a.m.