Skip to contents

Download MTBS perimeter or occurrence data

Source: R/get_mtbs.R
get_mtbs.Rd

Downloads an MTBS composite data ZIP archive to a directory. If the ZIP already exists and overwrite = FALSE, no network call is made.

Usage

get_mtbs(
  directory = getwd(),
  dataset = c("perimeters", "occurrence"),
  overwrite = FALSE,
  timeout = 3600,
  verbose = TRUE,
  dry_run = FALSE
)

Arguments

directory

character(1) directory where the ZIP file is stored. Defaults to the current working directory.

dataset

character(1) which dataset to download. Use "perimeters" (default) to get fire perimeters as polygons, or "occurrence" to get fire centroids as points.

overwrite

logical(1) re-download when TRUE; defaults to FALSE.

timeout

numeric(1) download timeout in seconds. The MTBS ZIP is ~360 MB, so the default is 3600 (one hour). Set to a lower value if you want a stricter limit.

verbose

logical(1) print progress messages.

dry_run

logical(1) if TRUE, do not download the file but instead return the path where it would be saved. Defaults to FALSE.

Value

character(1) path to the downloaded ZIP file (invisibly).

Warning [large files]

The MTBS ZIP archive is approximately 360 MB. Downloads may be slow depending on connection speed. Consider downloading in a background session if needed.

Examples

if (FALSE) { # \dontrun{
zip_path <- get_mtbs()
zip_path_pts <- get_mtbs(dataset = "occurrence")
} # }