ms_load_spatial_product: Read MacroSheds spatial data products from disk into R.

In MacroSHEDS/macrosheds: Tools for interfacing with the MacroSheds dataset

Read MacroSheds spatial data products from disk into R.

Description

Load a macrosheds spatial product (ws_boundary, precip_gauge_locations, or stream_gauge_locations) from a downloaded MacroSheds dataset. See ms_load_product() for core time-series data and watershed attributes.

Usage

ms_load_spatial_product(
  macrosheds_root,
  spatial_product,
  version = "latest",
  networks,
  domains,
  site_codes,
  warn = TRUE
)

Arguments

macrosheds_root	character. The path to the macrosheds dataset's parent directory, established with ms_download_core_data().
spatial_product	character. One of "stream_gauge_locations", "precip_gauge_locations", or "ws_boundary" (watershed boundary) Files associated with the requested product will be combined across specified networks/domains.
version	numeric or "latest". The MacroSheds dataset version from which to load data.
networks	character vector. MacroSheds networks to load; optional. Omit networks, domains, and site_codes to load all. For a catalog of networks, use ms_load_sites(), visit macrosheds.org, or see MacroSheds EDI
domains	character vector. MacroSheds domains to load; optional. Omit networks, domains, and site_codes to load all. For a catalog of domains, use ms_load_sites(), visit macrosheds.org, or see MacroSheds EDI
site_codes	character vector. MacroSheds networks to load; optional. Omit networks, domains, and site_codes to load all. For a catalog of sites, use ms_load_sites(), visit macrosheds.org, or see MacroSheds EDI
warn	logical. If TRUE, you'll get notifications about more recent versions of the MacroSheds dataset, if available.

Value

returns an sf object containing all data belonging to the selected spatial product in the macrosheds_root directory.

Author(s)

Spencer Rhea

Mike Vlah, [e-mail]

Wes Slaughter

See Also

ms_download_core_data(), ms_load_product(), ms_load_variables(), ms_load_sites()

Examples

ms_root = 'data/macrosheds'
ms_download_core_data(macrosheds_root = ms_root,
                      domains = c('niwot', 'hjandrews', 'hbef'))
macrosheds_data <- load_spatial_product(macrosheds_root = ms_root,
                                        spatial_product = 'ws_boundary'
                                        domains = 'hbef')

MacroSHEDS/macrosheds documentation built on Oct. 30, 2024, 11:15 a.m.