get_radar_imagery: Get BOM Radar Imagery

Description Usage Arguments Details Value Author(s) References See Also Examples

View source: R/get_radar_imagery.R

Description

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

Usage

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

Arguments

product_id

Character. BOM product ID to download and import as a raster object. 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 a temp directory.

download_only

Logical. Whether the radar image is loaded into the environment as a raster layer, or just downloded.

Details

Valid BOM satellite Product IDs for radar imagery can be obtained from get_available_radar.

Value

A raster layer based on the most recent '.gif' 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, [email protected]

References

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

See Also

get_available_radar

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Not run: 
# Fetch most recent radar image for Wollongong 256km radar
imagery <- get_radar_imagery(product_id = "IDR032")  
raster::plot(imagery)  

# Save imagery to a local path  
imagery <- get_radar_imagery(product_id = "IDR032", path = 'image.gif') 


## End(Not run)

bomrang documentation built on Sept. 12, 2018, 9:03 a.m.