Learn R Programming

bomrang: Australian Government Bureau of Meteorology (BOM) Data Client

Provides functions to interface with Australian Government Bureau of Meteorology (BOM) data, fetching data and returning a tidy data frame of précis forecasts, current weather data from stations, ag information bulletins, historical weather data and downloading and importing radar or satellite imagery.

Credit for the name, bomrang, goes to Di Cook, who suggested it while attending the rOpenSci AUUnconf in Brisbane, 2016.

Quick Start

Install the stable release from CRAN.

install.packages("bomrang")

Or from GitHub for the version in development.

if (!require("remotes")) {
  install.packages("remotes", repos = "http://cran.rstudio.com/")
  library("remotes")
}

install_github("ropensci/bomrang", build_vignettes = TRUE)

Using bomrang

Several functions are provided by bomrang to retrieve Australian Bureau of Meteorology (BOM) data. A family of functions retrieve weather data and return tidy data frames;

  • get_precis_forecast(), which retrieves the précis (short) forecast;

  • get_current_weather(), which fetches the current weather for a given station;

  • get_ag_bulletin(), which retrieves the agriculture bulletin;

  • get_weather_bulletin(), which retrieves the BOM 0900 or 1500 bulletins;

  • get_coastal_forecast(), which returns coastal waters forecasts;

  • get_historical_weather(), which retrieves historical daily observations for a given station; and

A second group of functions retrieve information pertaining to satellite and radar imagery,

  • get_available_imagery();

  • the satellite imagery itself, get_satellite_imagery();

  • get_available_radar(); and

  • the radar imagery itself, get_radar_imagery().

Vignettes are provided illustrating examples of all functions and a use case.

Meta

Contributor Code of Conduct. By participating in the bomrang project you agree to abide by its terms.

References

Australian Bureau of Meteorology (BOM) Weather Data Services

Australian Bureau of Meteorology (BOM) FTP Public Products

Australian Bureau of Meteorology (BOM) Weather Data Services Agriculture Bulletins

Australian Bureau of Meteorology (BOM) Weather Data Services Observation of Rainfall

Australian Bureau of Meteorology (BOM) High-definition satellite images

Copy Link

Version

Install

install.packages('bomrang')

Monthly Downloads

67

Version

0.7.4

License

MIT + file LICENSE

Issues

Pull Requests

Stars

Forks

Maintainer

Adam Sparks

Last Published

March 29th, 2021

Functions in bomrang (0.7.4)

get_available_imagery

Get a listing of available BOM satellite GeoTIFF imagery
filter

Objects exported from other packages
get_historical_weather

Obtain historical BOM data
get_precis_forecast

Get BOM daily pr<U+00E9>cis forecast for select towns from BOM
get_available_radar

Get a listing of available BOM radar imagery
get_coastal_forecast

Get BOM coastal waters forecast
get_ag_bulletin

Get BOM agriculture bulletin information for select stations
arrange

Objects exported from other packages
bomrang-package

bomrang: Australian Government Bureau of Meteorology ('BOM') Data Client
get_current_weather

Get current weather observations of a BOM station
select

Objects exported from other packages
get_weather_bulletin

Get BOM 0900 or 1500 weather bulletin
get_radar_imagery

Get BOM radar imagery
parse_coastal_forecast

Parse local BOM coastal waters forecast XML files
update_forecast_towns

Update internal database with latest BOM forecast towns
parse_ag_bulletin

Parse local BOM agriculture bulletin XML file(s) for select stations
sweep_for_forecast_towns

Find nearest BOM forecast towns
sweep_for_stations

Find nearest BOM weather stations
group_by

Objects exported from other packages
manage_cache

Manage locally cached bomrang files
update_station_locations

Update internal databases with latest BOM station metadata
mutate

Objects exported from other packages
parse_precis_forecast

Parse local BOM daily pr<U+00E9>cis forecast XML file(s) for select towns
get_satellite_imagery

Get BOM Satellite GeoTIFF Imagery
%>%

Pipe operator
reexports

Objects exported from other packages
rename

Objects exported from other packages
slice

Objects exported from other packages