Function to calculate summary statistics for daily hydrologic time series.
Usage
summaryStats(dataset, staid = 1)
Arguments
dataset
is the data frame containing hydrologic data
staid
is used to label the output
Value
a data frame containing a number of summary statistics of the daily
hydrologic data series
Format
The returned matrix has the following columns, which are formatted
for putting in a report or table.
Name
Type
Description
Begin
character
The beginning date of the time series
End
character
The ending date of the time series
n
character
Number of rows
NA
character
Number of missing values
Neg
character
Number of negative values
Min
character
The minimum value
Q1
character
The first quartile, 25th percentile
Med
character
The median
Mean
character
The mean
Q3
character
The third quartile, 75th percentile
Max
character
The maximum value
StdDev
character
The standard deviation
IQR
character
The interquartile range
Details
The summary statistics returned are useful for exploratory data analysis
and for describing the date set.
References
Helsel, D.R. and Hirsch, R. M., 2002, Statistical methods in water resources:
U.S. Geolgical Survey Techniques of Water Resources Investigations, book 4,
chap. A3, 522 p. (Also available at http://pubs.usgs.gov/twri/twri4a3/).