get_weather_bulletin: Get BOM 0900 or 1500 weather bulletin

View source: R/get_weather_bulletins.R

get_weather_bulletinR Documentation

Get BOM 0900 or 1500 weather bulletin

Description

Fetch the daily BOM 0900 or 1500 weather bulletins and return a data frame for a specified state or territory.

Usage

get_weather_bulletin(state = "qld", morning = TRUE)

Arguments

state

Australian state or territory as full name or postal code. Fuzzy string matching via agrep is done.

morning

If TRUE, return the 9am bulletin for the nominated state; otherwise return the 3pm bulletin.

Details

Allowed state and territory postal codes:

ACT

Australian Capital Territory (will return NSW)

NSW

New South Wales

NT

Northern Territory

QLD

Queensland

SA

South Australia

TAS

Tasmania

VIC

Victoria

WA

Western Australia

It is not possible to return weather bulletins for the entire country in a single call. Rainfall figures for the 9am bulletin are generally for the preceding 24 hours, while those for the 3pm bulletin are for the preceding 6 hours since 9am. Note that values are manually entered into the bulletins and sometimes contain typographical errors which may lead to warnings about "NAs introduced by coercion".

Value

Data frame as a data.table object of Australian 9am or 3pm weather observations for a state. For full details of fields and units returned see Appendix 4, "Appendix 4 - Output from get_weather_bulletin()" in the bomrang vignette, use
vignette("bomrang", package = "bomrang") to view.

Author(s)

Mark Padgham, mark.padgham@email.com

References

Daily observation data come from Australian Bureau of Meteorology (BOM) website. The 3pm bulletin for Queensland is, for example,
http://www.bom.gov.au/qld/observations/3pm_bulletin.shtml

Examples


qld_weather <- get_weather_bulletin(state = "QLD", morning = FALSE)
qld_weather


ToowoombaTrio/BOMRang documentation built on Jan. 31, 2023, 3:10 p.m.