WaterML (version 1.9.5)

HISCentral_GetSeriesCatalog: HISCentral_GetSeriesCatalog

Description

This function searches the table of time series from the HIS Central catalog

Usage

HISCentral_GetSeriesCatalog(
  west,
  south,
  east,
  north,
  serviceID = NULL,
  keyword = NULL,
  beginDate = NULL,
  endDate = NULL
)

Arguments

west

The west longitude of the geographic bounding box in decimal degrees. Allowed values are between -180.0 and +180.0

south

The south latitude of the geographic bounding box in decimal degrees. Allowed values are between -90.0 and +90.0

east

The east longitude of the geographic bounding box in decimal degrees. Allowed values are between -180.0 and +180.0

north

The north latitude of the geographic bounding box in decimal degrees. Allowed values are between -90.0 and +90.0

serviceID

(optional): The ID of the service on HIS Central. To get the service ID, use the id column in the output of the GetServices() function.

keyword

(optional): The concept keyword (common name of variable) for searching the sites on HIS Central. Examples include Temperature, Precipitation, Snow Depth,... If the Keyword is not specified then sites with any variable will be returned.

beginDate

(optional): The begin date of the observations in yyyy-mm-dd format.

endDate

(optional): The end date of the observations in yyyy-mm-dd format.

Value

a data.frame of series catalog entries. The data.frame has the following columns:

• ServiceCode: The code of the HydroServer

• ServiceURL: The URL of the server. Use this as the server parameter in GetValues() function.

• FullSiteCode: The complete unique code of the site in the format NETWORK:CODE. Use this value as the siteCode parameter in the GetValues function.

• FullVariableCode: The complete unique code of the site in the format VOCABULARY:CODE. Use this value as the variableCode parameter in the GetValues function.

• BeginDateTime: The local date/time of the first observation of the time series in POSIXct format.

• EndDateTime: The local date/time of the last observation of the time series in POSIXct format.

• ValueCount: The number of measurements in the time series

• SiteName: The name of the site.

• Latitude: The WGS84 latitude of the site in decimal degrees

• Longitude: The WGS84 longitude of the site in decimal degrees

• DataType: The data type of the variable

• ValueType: The type of the observation (field observation, sample, or derived value)

• SampleMedium: The sample medium (air, water or other)

• TimeUnits: The time units

• TimeSupport: The length of the time period of one measurement

Examples

# NOT RUN {
#Getting all time series from the (14.1E, 49.9N, 14.3E, 50.1N) bounding box
series_catalog <- HISCentral_GetSeriesCatalog(west=14.1, south=49.9, east=14.3, north=50.1)
# }