rnrfa (version 1.5.0)

get_ts: This function retrieves time series data.

Description

Given the station identification number(s), this function retrieves data (time series in zoo format with accompanying metadata) from the WaterML2 service on the NRFA database. The time series can be of two types: cmr (catchment mean rainfall, monthly) or gdf (gauged daily flows, daily).

Usage

get_ts(id, type, metadata = FALSE, cl = NULL, verbose = FALSE)

Arguments

id

station identification number(s), each number should be in the range [3002,236051].

type

This is character string that can have one of the two following values: "cmr" (to obtain catchment mean rainfall) or "gdf" (to obtain gauged daily flow).

metadata

Logical, FALSE by default. If metadata = TRUE means that the result for a single station is a list with two elements: data (the time series) and meta (metadata).

cl

(optional) This is a cluster object, created by the parallel package. This is set to NULL by default, which sends sequential calls to the server.

verbose

(FALSE by default). If set to TRUE prints GET request on the console.

Value

list composed of as many objects as in the list of station identification numbers. Each object can be accessed using their names or index (e.g. x[[1]], x[[2]], and so forth). Each object contains a zoo time series.

Examples

# NOT RUN {
  get_ts(18019, type = "cmr")

  get_ts(c(54022,54090,54091), type = "cmr")

  get_ts(18019, type = "gdf")

  get_ts(c(54022,54090,54091), type = "gdf")
# }
# NOT RUN {
# }