bomrang v0.7.0

0

Monthly downloads

0th

Percentile

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 precis forecasts, historical and current weather data from stations, agriculture bulletin data, 'BOM' 0900 or 1500 weather bulletins and downloading and importing radar and satellite imagery files. Data (c) Australian Government Bureau of Meteorology Creative Commons (CC) Attribution 3.0 licence or Public Access Licence (PAL) as appropriate. See <http://www.bom.gov.au/other/copyright.shtml> for further details.

Readme

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

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.

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

Functions in bomrang

Name Description
manage_cache Manage locally cached bomrang files
sweep_for_stations Find nearest BOM weather stations
group_by Objects exported from other packages
get_weather_bulletin Get BOM 0900 or 1500 weather bulletin
sweep_for_forecast_towns Find nearest BOM forecast towns
get_precis_forecast Get BOM daily pr<U+00E9>cis forecast for select towns from BOM
select Objects exported from other packages
mutate Objects exported from other packages
slice Objects exported from other packages
parse_ag_bulletin Parse local BOM agriculture bulletin XML file(s) for select stations
reexports Objects exported from other packages
rename Objects exported from other packages
get_radar_imagery Get BOM radar imagery
parse_coastal_forecast Parse local BOM coastal waters forecast XML files
get_satellite_imagery Get BOM Satellite GeoTIFF Imagery
update_station_locations Update internal databases with latest BOM station metadata
update_forecast_towns Update internal database with latest BOM forecast towns
parse_precis_forecast Parse local BOM daily pr<U+00E9>cis forecast XML file(s) for select towns
%>% Pipe operator
get_available_radar Get a listing of available BOM radar imagery
get_ag_bulletin Get BOM agriculture bulletin information for select stations
arrange Objects exported from other packages
get_current_weather Get current weather observations of a BOM station
get_available_imagery Get a listing of available BOM satellite GeoTIFF imagery
get_historical Obtain historical BOM data
bomrang Australian government Bureau of Meteorology (BOM) data client
filter Objects exported from other packages
get_coastal_forecast Get BOM coastal waters forecast
No Results!

Vignettes of bomrang

Name
bomrang.Rmd
bomrang.Rmd.orig
completeness_map-1.png
get_radar_imagery-1.png
get_satellite_imagery-1.png
precompile.R
station-locations-map-1.png
use_case.Rmd
use_case.Rmd.orig
years_available-1.png
No Results!

Last month downloads

Details

Type Package
URL https://github.com/ropensci/bomrang, https://docs.ropensci.org/bomrang/
BugReports https://github.com/ropensci/bomrang/issues
License MIT + file LICENSE
Encoding UTF-8
LazyData true
Language en-AU
RoxygenNote 7.0.2
NeedsCompilation no
ByteCompile TRUE
VignetteBuilder knitr
X-schema.org-applicationCategory Tools
X-schema.org-keywords bom, meteorological-data, weather-forecast, australia, weather, weather-data, meteorology, australia-bureau-of-meteorology
X-schema.org-isPartOf https://ropensci.org
Packaged 2020-01-20 04:03:47 UTC; adamsparks
Repository CRAN
Date/Publication 2020-01-20 19:30:29 UTC

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/bomrang)](http://www.rdocumentation.org/packages/bomrang)