download_os_data_package: Download a data package from Ordinance Survey Data Hub

View source: R/download_os_data_package.R

download_os_data_packageR Documentation

Download a data package from Ordinance Survey Data Hub

Description

Download a data package from Ordinance Survey Data Hub

Usage

download_os_data_package(
  key = Sys.getenv("OS_API_KEY"),
  data_package_id,
  data_package_version = NA,
  destination,
  unzip = TRUE
)

Arguments

key

OS Data Hub API key (with permissions for required data package. Default is the environment variable Sys.getenv("OS_API_KEY").

data_package_id

Data package ID

data_package_version

Data package version. Default if NA is most recent.

destination

Destination (folder if unzip == TRUE or file if unzip == FALSE).

unzip

Whether or not to unzip the file. Default is TRUE.


nhsbsa-data-analytics/addressMatchR documentation built on June 16, 2024, 6:03 a.m.