siteList.Rd
Information about the registered sites in a SOS can be queried using this function. This function allows for different levels of detail and returns a vector or data.frame.
siteList(sos, empty = FALSE, begin = NA, end = NA, phenomena = list(), includePhenomena = FALSE, includeTemporalBBox = FALSE, ...)
sos | A SOS object from a call to |
---|---|
empty | Whether also empty sites shall be included in the response. |
begin | Object of class |
end | Object of class |
phenomena | A list, vector or one-column data.frame with characters identifying the relevant phenomena. |
includePhenomena | Whether the phenomena shall also be reported in the result. |
includeTemporalBBox | Whether the observation containing timespan of each phenomenon shall also be reported. |
... | Named parameters passed on to other wrapper functions. |
If only the argument sos
is provided and the flag empty
is set to TRUE
or FALSE
, this function returns a character vector with the site ids.
If listPhenomena = TRUE
, the data.frame contains the column containing the site ids and a character column phenomenon where sites with several phenomena are repeated for each of their phenomenon.
If includeTemporalBBox = TRUE
, the data.frame also contains two character columns beginTime
and endTime
indicating per site id and phenomenon its earliest and latest observation time point.
if (FALSE) { mySos <- SOS(url = "https://climate-sos.niwa.co.nz/", binding = "KVP", useDCPs = FALSE, version = "2.0.0") siteList(sos = mySos) }