Skip to contents

Download RSYC Ecological Boundaries

Source: R/ecostrat.R
download_rsyc_boundaries.Rd

Download and save the ecological boundary maps used by RSYC. The file is not downloaded when the package is installed or loaded. It contains maps of ecozones, ecoprovinces, ecoregions, and ecodistricts, but no yield curves. Tile boundaries are already included with RSYC.

Usage

download_rsyc_boundaries(
  cache_dir = tools::R_user_dir("RSYC", "data"),
  overwrite = FALSE,
  quiet = FALSE,
  url = getOption("RSYC.ecostrat_url", .rsyc_ecostrat_url)
)

Arguments

cache_dir

Folder in which to save the GeoPackage. By default, RSYC uses its standard user data folder, returned by tools::R_user_dir().

overwrite

Replace a previously downloaded file?

quiet

Hide download progress?

url

Web address of the boundary file. The default points to the copy published with RSYC. Organizations may instead provide the address of an approved copy. Its contents must match the published file.

Value

The full location of the saved GeoPackage. The function returns this location without printing it.

See also

rsyc_boundaries()

Examples

# \donttest{
# Save to a temporary folder here; omit `cache_dir` to use the default.
path <- try(download_rsyc_boundaries(cache_dir = tempdir()))
#> Cached RSYC ecological stratification at: /tmp/RtmpiYOM7x/RSYC_ecostrat.gpkg
# }