README-old.md

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

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.

NOTE

BOM have decided that the data that they provide should not all be easily available. Therefore, some portions of this package (any that depend on HTTP requests) are now broken. These include:

• get_historical_weather(),
• get_weather_bulletins(), and
• get_current_weather()

All other functions in the package work as advertise assuming server availability as they rely on FTP requests.

BOM's official statement

Website notification of change Scheduled Release Date: 3 March 2021 A web application firewall policy has been implemented for www.bom.gov.au which will block screen scraping activity. The Bureau is monitoring screen scraping activity on the site and will commence interrupting, and eventually blocking, this activity on www.bom.gov.au from Wednesday, 3 March 2021. This is aimed at protecting infrastructure, system access and security, intellectual property and server/service load. Web or screen scraping is the act of copying information that shows on a digital display so it can be used for another purpose. This activity has always been at odds with the Bureau's terms and conditions. We understand www.bom.gov.au contributes significantly to the work of many individuals and organisations and we are committed to continuing to provide access through our registered user’s channel. For further information, or to discuss the ongoing use of our materials, please make contact with us via [e-mail].

Quick Start

bomrang has been archived from CRAN for reasons beyond bomrang actually being broken. As such at this time I've declined to "fix" the package. It can still be installed using the following commands.

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

• Please report any issues or bugs.

• License:

  • All code is licensed MIT

  • All data is copyright Australia Bureau of Meteorology, BOM Copyright Notice http://reg.bom.gov.au/other/copyright.shtml

• To cite bomrang, please use the output from citation("bomrang")

• Please note that the bomrang project is released with a 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

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