Download the CAMELS-PE dataset from Zenodo

Downloads the CAMELS-PE dataset zip file from the Zenodo repository (doi:10.5281/zenodo.21195425 ) and extracts it in the destination folder.

Usage

download_pe_data(
  dest_dir,
  unzip = TRUE,
  overwrite = FALSE,
  quiet = FALSE,
  version = "1.0.1",
  set_path = TRUE
)

Arguments

dest_dir

Character string. Destination directory where the dataset should be saved.

unzip

Logical. Should the downloaded file be unzipped? Default is TRUE.

overwrite

Logical. If destination files already exist, should they be overwritten? Default is FALSE.

quiet

Logical. Should download progress be suppressed? Default is FALSE.

version

Character string. Dataset release: "1.0.1" (default) or "1.0".

set_path

Logical. Configure the session path after extraction only.

Value

Character string indicating the directory path where the dataset is located or extracted; the ZIP path when unzip = FALSE. Use a separate destination for each release, or overwrite = TRUE to replace an existing extraction.

Examples

# \donttest{
# Download to a temporary folder
download_pe_data(dest_dir = tempdir())
#> Zip file already exists. Use `overwrite = TRUE` to download again.
#> Unzipping dataset to /tmp/RtmplFsldc...
#> [1] "/tmp/RtmplFsldc/CAMELS-PE"
# }