parse_precis_forecast: Parse local BOM daily précis forecast XML file(s) for select...

In adamhsparks/BOMRang: Australian Government Bureau of Meteorology ('BOM') Data Client

Parse local BOM daily précis forecast XML file(s) for select towns

Description

Parse local BOM daily précis forecast XML file(s) and return a data frame of the seven-day town forecasts for a specified state or territory or all Australia.

Usage

parse_precis_forecast(state, filepath)

Arguments

state	Required value of an Australian state or territory as full name or postal code. Fuzzy string matching via agrep is done.
filepath	A string providing the directory location of the précis file(s) to parse. See Details for more.

Details

Allowed state and territory postal codes, only one state per request or all using AUS.

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

AUS

Australia, returns forecast for all states, NT and ACT

The filepath argument will only accept a directory where files are located for parsing. DO NOT supply the full path including the file name. This function will only parse the requested state or all of Australia in the same fashion as get_precis_forecast, provided that the files are all present in the directory.

Value

A data.table of Australia BOM précis seven day forecasts for BOM selected towns. For full details of fields and units returned see Appendix 2 in the bomrang vignette, use
vignette("bomrang", package = "bomrang") to view.

Author(s)

Adam H. Sparks, [e-mail] and Keith Pembleton, [e-mail] and Paul Melloy, [e-mail]

References

Forecast data come from Australian Bureau of Meteorology (BOM) Weather Data Services
http://www.bom.gov.au/catalogue/data-feeds.shtml

Location data and other metadata for towns come from the BOM anonymous FTP server with spatial data
ftp://ftp.bom.gov.au/anon/home/adfd/spatial/, specifically the DBF file portion of a shapefile,
ftp://ftp.bom.gov.au/anon/home/adfd/spatial/IDM00013.dbf

See Also

get_precis_forecast

Examples

# parse the short forecast for Queensland

# download to tempfile() using basename() to keep original name
download.file(url = "ftp://ftp.bom.gov.au/anon/gen/fwo/IDQ11295.xml",
              destfile = file.path(tempdir(),
              basename("ftp://ftp.bom.gov.au/anon/gen/fwo/IDQ11295.xml")),
              mode = "wb")

BOM_forecast <- parse_precis_forecast(state = "QLD",
                                      filepath = tempdir())

BOM_forecast

adamhsparks/BOMRang documentation built on Jan. 31, 2023, 4:49 a.m.