get_radar_imagery {weatherOz}

Get BOM Radar Imagery

Description

Fetch BOM radar imagery from ftp://ftp.bom.gov.au/anon/gen/radar/ and return a magick image object. Files available are the most recent radar snapshot which are updated approximately every 6 to 10 minutes. It is suggested to check file availability first by using get_available_radar().

Usage

get_radar_imagery(product_id, path = NULL, download_only = FALSE)

Arguments

product_id

Character. BOM product ID to download and import. Value is required.

path

Character. A character string with the name where the downloaded file is saved. If not provided, the default value NULL is used which saves the file in an R session temp directory.

download_only

Boolean. Whether the radar image is loaded into the environment as a magick object or just downloaded. Defaults to FALSE

Details

Valid BOM Radar Product IDs for radar imagery can be obtained from get_available_radar().

Value

A magick object of the most recent radar image snapshot published by the BOM. If download_only = TRUE there will be a NULL return value with the download path printed in the console as a message.

Author(s)

Dean Marchiori, [e-mail]

References

Australian Bureau of Meteorology (BOM) radar images
http://www.bom.gov.au/australia/radar/

See Also

get_available_radar()

Other BOM: find_forecast_towns(), get_ag_bulletin(), get_available_imagery(), get_available_radar(), get_coastal_forecast(), get_precis_forecast(), get_satellite_imagery(), parse_ag_bulletin(), parse_coastal_forecast(), parse_precis_forecast()

Other data fetching: get_ag_bulletin(), get_coastal_forecast(), get_data_drill(), get_data_drill_apsim(), get_dpird_apsim(), get_dpird_extremes(), get_dpird_minute(), get_dpird_summaries(), get_patched_point(), get_patched_point_apsim(), get_precis_forecast(), get_satellite_imagery()

Examples

# Fetch most recent radar image for Wollongong 256km radar
imagery <- get_radar_imagery(product_id = "IDR032")
imagery