Skip to contents

Downloads a hydrofabric Geopackage from a specified URL and saves it to a local file.

Usage

get_hydrofabric(
  url = "https://lynker-spatial.s3-us-west-2.amazonaws.com/hydrofabric",
  version = "2.2",
  domain = "conus",
  type = "nextgen",
  outfile = NULL,
  overwrite = FALSE
)

Arguments

url

A character string specifying the base URL of the hydrofabric repository. Defaults to `'https://lynker-spatial.s3-us-west-2.amazonaws.com/hydrofabric'`.

version

A character string indicating the version of the hydrofabric to download. Defaults to `'2.2'`.

domain

A character string specifying the geographic domain of the hydrofabric. Defaults to `'conus'`.

type

A character string indicating the type of hydrofabric. Defaults to `'nextgen'`.

outfile

A character string specifying the path to save the downloaded file. If `NULL`, the file will not be saved. Defaults to `NULL`.

overwrite

A logical value indicating whether to overwrite an existing file. Defaults to `FALSE`.

Value

The function returns the path to the downloaded file (`outfile`).

Examples

if (FALSE) { # \dontrun{
# Download the default hydrofabric file
get_hydrofabric(outfile = "conus_nextgen.gpkg")

# Specify a different domain and version
get_hydrofabric(
  version = "3.0",
  domain = "hawaii",
  outfile = "hawaii_nextgen.gpkg",
  overwrite = TRUE
)
} # }