Learn R Programming

FlowScreen (version 0.9)

station.info: Retrieve Station Info

Description

Returns station information for Water Survey Canada or United States Geological Survey stream gauges.

Usage

station.info(TS, StnInfo = NULL, Plot = F, language = "English")

Arguments

TS
output from create.ts containing a data.frame of flow
StnInfo
Optional data.frame containing user-supplied station info for plot. data.frame must have 7 columns containing station info in the following order: Station ID, Station Name, Prov/State, Country, Latitude, Longitude, Catchment Area If any of the informa
Plot
Boolean indicating whether a plot of station information should be created. Default is F. Plot is intended for use as the upper-left panel of the plot produced by screen.summary.
language
Language for plotting when Plot = T. Choice of either "English" or "French". Default is "English".

Value

  • Returns a list of the following station information:
    • $StationID
    • $StnName
    • $Prov/State - Abbreviation for the province or state in which the station is located
    • $Country - Abbreviation for the country in which the station is located
    • $Lat - Latitude of the station
    • $Long - Longitude of the station
    • $Area - Catchment area, in square kilometers
    • $RHN - Boolean indicating whether the station is part of a reference hydrologic network

Examples

Run this code
data(cania.sub.ts)
StnInfo <- station.info(cania.sub.ts)

Run the code above in your browser using DataLab