Skip to contents

Download a BC Data Catalogue Layer to a GeoPackage

Source: R/spk_source_bcdata.R
spk_source_bcdata.Rd

Downloads a layer from the BC Data Catalogue, optionally intersects it with a mask, and writes it to a GeoPackage.

Usage

spk_source_bcdata(
  bcdata_record_id = NULL,
  path_gpkg = NULL,
  mask = NULL,
  layer_name = NULL
)

Arguments

bcdata_record_id

character A BC Data Catalogue record permanent id (e.g. 7ecfafa6-5e18-48cd-8d9b-eae5b5ea2881), record name (e.g. pscis-assessments) or object name (e.g. WHSE_FISH.PSCIS_ASSESSMENT_SVW). Record names can be found at https://catalogue.data.gov.bc.ca/. Case is not significant — the value is upper-cased within the function.

path_gpkg

character Path to the output GeoPackage file. Must already exist.

mask

sf::sf Optional masking polygon used to clip the spatial extent.

layer_name

character Optional layer name to write to the GeoPackage. If NULL, defaults to bcdata_record_id lower-cased. Designed to work best when an object name is passed as bcdata_record_id.

Value

The value of sf::st_write(), invisibly. Called for its side effects.

Details

Passing a mask can massively increase download speed, because the bounding box of the mask is pushed down into the catalogue API query rather than the full layer being collected and clipped locally.

See also

spk_source_url() for pulling layers from arbitrary URLs.

Other download: spk_source_url()

Examples

if (FALSE) { # \dontrun{
path_gpkg <- fs::path(tempdir(), "layers.gpkg")
get_this <- c("whse_basemapping.bcgs_5k_grid", "WHSE_BASEMAPPING.BCGS_2500_GRID")
name_this <- c("grid_5k", "grid_2500")
purrr::walk2(
  .x = get_this,
  .y = name_this,
  .f = ~ spk_source_bcdata(
    bcdata_record_id = .x,
    path_gpkg = path_gpkg,
    layer_name = .y
  )
)
} # }