bomrang (version 0.7.0)

get_coastal_forecast: Get BOM coastal waters forecast

Description

Fetch the BOM daily Coastal Waters Forecast and return a data frame of the forecast regions for a specified state or region.

Usage

get_coastal_forecast(state = "AUS")

Arguments

state

Australian state or territory as full name or postal code. Fuzzy string matching via agrep is done. Defaults to "AUS" returning all state forecasts, see details for further information.

Value

A data.table of an Australia BOM Coastal Waters Forecast. For full details of fields and units returned see Appendix 5 in the bomrang vignette, use vignette("bomrang", package = "bomrang") to view.

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

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 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/IDM00003.dbf

See Also

parse_coastal_forecast()

Examples

# NOT RUN {
coastal_forecast <- get_coastal_forecast(state = "NSW")
coastal_forecast
# }

Run the code above in your browser using DataCamp Workspace