FlowScreen (version 2.0)

station.info: Retrieve Station Info

Description

Returns station information from metadata included in the package data files. If there is no metadata match for the StationID AND Agency, returns NA values for all other columns.

Usage

station.info(Agency, StationID, Plot = FALSE, Language = "English")

Value

Returns a data.frame of the following station information:

• $Agency - Name of Agency from which the record came

• $StationID

• $StnName

• $StateProv - State, Province, or Territory where the station is located

• $Country - Country in which the station is located

• $Lat - Latitude of the station, numeric

• $Lon - Longitude of the station, numeric

• $CatchmentArea_km2 - total drainage area in square kilometers

• $RHN - Indication whether the station is part of a reference hydrologic network, TRUE/FALSE

• $MetadataSource - Indication of where the metadata came from, e.g. WSC Hydat, USGS, user-supplied.

• $StationID_Alternate - Alternate station ID, e.g. original station ID versus ROBIN database

Arguments

Agency

String indicating Agency where streamflow data.

StationID

String of the Station ID

Plot

Boolean indicating whether a plot of station information should be created. Default is FALSE. 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".

Author

Jennifer Dierauer

Examples

data(cania.sub.ts)
stn_metdat <- station.info(cania.sub.ts$Agency[1], cania.sub.ts$ID[1])
print(stn_metdat)