R/cmr.R

In rnrfa: UK National River Flow Archive Data from R

#' This function retrieves Catchment Mean Rainfall (cmr).
#'
#' @author Claudia Vitolo
#'
#' @description Given the station ID number(s), this function retrieves data
#' (time series in zoo format with accompanying metadata) from the WaterML2
#' service on the NRFA database. Catchment Mean Rainfall is measured in
#' mm/month.
#'
#' @param id station ID number(s), each number should be in the range
#' [3002,236051].
#' @param 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).
#' @param 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.
#' @param verbose (FALSE by default). If set to TRUE prints GET request on the
#' console.
#'
#' @return list composed of as many objects as in the list of station ID
#' 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.
#'
#' @export
#'
#' @examples
#' \dontrun{
#'   cmr(18019)
#'   cmr(c(54022,54090,54091))
#' }

cmr <- function(id, metadata = FALSE, cl = NULL, verbose = FALSE) {

  rain <- get_ts(id, type = "cmr", metadata, cl, verbose)

  return(rain)

}