get_historical: Obtain Historical BOM Data

Description Usage Arguments Value Author(s) Examples

View source: R/get_historical.R

Description

Retrieves daily observations for a given station.

Usage

1
2
get_historical(stationid = NULL, latlon = NULL, type = c("rain",
  "min", "max", "solar"), meta = FALSE)

Arguments

stationid

BOM station ID. See Details.

latlon

Length-2 numeric vector of Latitude/Longitude. See Details.

type

Measurement type, either daily "rain", "min" (temp), "max" (temp), or "solar" (exposure). Partial matching is performed. If not specified returns the first matching type in the order listed.

meta

Logical switch to include metadata information on the station and data from BOM. If set to TRUE a list is returned with a

Value

By default a complete data.frame of historical observations for the chosen station, with some subset of the following columns

Product_code: BOM internal code.
Station_number: BOM station ID.
Year: Year of observation (YYYY).
Month: Month of observation (1-12).
Day: Day of observation (1-31).
Min_temperature: Minimum daily recorded temperature (degrees C).
Max_temperature: Maximum daily recorded temperature (degrees C).
Accum_days_min: Accumulated number of days of minimum temperature.
Accum_days_max: Accumulated number of days of maximum temperature.
Rainfall: Daily recorded rainfall in mm.
Period: Period over which rainfall was measured.
Solar_exposure: Daily global solar exposure in MJ/m^2.
Quality: Y, N, or missing. Data which have not yet completed the
routine quality control process are marked accordingly.

If meta is set TRUE, then a list is returned with an additional data.frame with the following columns giving information on the station and data.

site: BOM station ID.
name: BOM station name.
lat: Latitude in decimal degrees.
lon: Longitude in decimal degrees.
start: Date observations start.
end: Date observations end.
years: Available number of years data.
percent: Percent complete.
AWS: Automated weather station?
type: Measurement types available for the station.

Temperature data prior to 1910 should be used with extreme caution as many stations, prior to that date, were exposed in non-standard shelters, some of which give readings which are several degrees warmer or cooler than those measured according to post-1910 standards.

Daily maximum temperatures usually occur in the afternoon and daily minimum temperatures overnight or near dawn. Occasionally, however, the lowest temperature in the 24 hours to prior to 9 AM can occur around 9 AM the previous day if the night was particularly warm.

Either stationid or latlon must be provided, but if both are, then stationid will be used as it is more reliable.

In some cases data is available back to the 1800s, so tens of thousands of daily records will be returned. Other stations will be newer and will return fewer observations.

Author(s)

Jonathan Carroll, [email protected]

Examples

1
2
3
4
5
6
## Not run: 
get_historical(stationid = "023000", type = "max") ## ~48,000+ daily records
get_historical(latlon = c(-35.2809, 149.1300),
               type = "min") ## 3,500+ daily records

## End(Not run)

bomrang documentation built on Sept. 12, 2018, 9:03 a.m.