Rating table for an active USGS streamgage retrieval

Reads current rating table for an active USGS streamgage from NWISweb.

Usage

readNWISrating(
  siteNumber,
  type = "base",
  convertType = TRUE,
  override_error = FALSE
)

Arguments

siteNumber

character USGS site number. This is usually an 8 digit number

type

character can be "base", "corr", or "exsa"

convertType

logical, defaults to TRUE. If TRUE, the function will convert the data to dates, datetimes, numerics based on a standard algorithm. If false, everything is returned as a character

override_error

Logical parameter that allows users to run this function during the final stages of NWIS decommission. NWIS servers will be taken offline February 22nd, 2027. Setting this parameter to TRUE should only be used as a tool to convert readNWIS to read_waterdata functions.

Value

A data frame. If type is "base, " then the columns are INDEP, typically the gage height, in feet; DEP, typically the streamflow, in cubic feet per second; and STOR, where "*" indicates that the pair are a fixed point of the rating curve. If type is "exsa, " then an additional column, SHIFT, is included that indicates the current shift in the rating for that value of INDEP. If type is "corr, " then the columns are INDEP, typically the gage height, in feet; CORR, the correction for that value; and CORRINDEP, the corrected value for CORR.
If type is "base, " then the data frame has an attribute called "RATING" that describes the rating curve is included.

There are also several useful attributes attached to the data frame:

Name	Type	Description
url	character	The url used to generate the data
queryTime	POSIXct	The time the data was returned
comment	character	Header comments from the RDB file
siteInfo	data.frame	A data frame containing information on the requested sites
RATING	character	Rating information

Note

Not all active USGS streamgages have traditional rating curves that relate flow to stage.

See also

constructNWISURL(), importRDB1()

Examples

site_id <- "01594440"
# \donttest{
#data <- readNWISrating(site_id, "base")
#attr(data, "RATING")
# }