Australian government Bureau of Meteorology (BOM) data client for R
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci increase timeout for tests May 29, 2018
.github
R Update pkgdown site Oct 20, 2018
data-raw
docs Update pkgdown site Oct 20, 2018
inst
man Update documentation Nov 11, 2018
revdep
tests
vignettes Update table in Appendix 3 to match get_ag_bulletin() output Sep 27, 2018
.Rbuildignore
.gitattributes
.gitignore
CONDUCT.md
DESCRIPTION Add pkgdown to suggests for automating building Oct 20, 2018
LICENSE Now fetches complete forecast for all states May 12, 2017
NAMESPACE
NEWS.md
README.md
_pkgdown.yml Remove trailing "/" from URL to fix search Jun 26, 2018
appveyor.yml Test as NOT_CRAN on appveyor Jun 17, 2018
bomrang.Rproj
codecov.yml Use nocov in zzz.R and clean up codecov.yml May 10, 2018
codemeta.json
cran-comments.md

README.md

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

CircleCI Appveyor codecov DOI CRAN_Status_Badge status Project Status: Active – The project has reached a stable, usable state and is being actively developed.

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, upon seeing the vignette that we had assembled during the Unconf.

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; and
  • get_historical(), which retrieves historical daily observations for a given station.

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

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