Download gridMET data — download

The download_gridmet function accesses and downloads gridded surface meteorological data from the University of California Merced Climatology Lab's gridMET dataset.

Usage

download_gridmet(
  variables = NULL,
  year = c(2018, 2022),
  directory_to_save = NULL,
  acknowledgement = FALSE,
  download = FALSE,
  remove_command = FALSE,
  hash = FALSE
)

Arguments

variables: character(1). Variable(s) name(s). See gridMET Generate Wget File for variable names and acronym codes. (Note: variable "Burning Index" has code "bi" and variable "Energy Release Component" has code "erc").
year: character(1 or 2). length of 4. Year or start/end years for downloading data.
directory_to_save: character(1). Directory(s) to save downloaded data files.
acknowledgement: logical(1). By setting TRUE the user acknowledges that the data downloaded using this function may be very large and use lots of machine storage and memory.
download: logical(1). FALSE will generate a *.txt file containing all download commands. By setting TRUE the function will download all of the requested data files.
remove_command: logical(1). Remove (TRUE) or keep (FALSE) the text file containing download commands.
hash: logical(1). By setting TRUE the function will return an rlang::hash_file() hash character corresponding to the downloaded files. Default is FALSE.

Value

For hash = FALSE, NULL
For hash = TRUE, an rlang::hash_file character.
netCDF (.nc) files will be stored in a variable-specific folder within directory_to_save.

References

article_abatzoglou2013developmentamadeus

Author

Mitchell Manware

Examples

if (FALSE) { # \dontrun{
download_gridmet(
  variables = "Precipitation",
  year = 2023,
  directory_to_save = tempdir(),
  acknowledgement = TRUE,
  download = FALSE, # NOTE: download skipped for examples,
  remove_command = TRUE
)
} # }