Skip to contents

Retrieve and Save GMD Catalog Datasets to a Local Directory

pipdata_get_gmd.Rd

This wrapper function automates the process of managing GMD catalog datasets by performing the following tasks:

  1. Checks for new datasets in the GMD catalog using the inventory file (dlw_gmd_inv), which contains the current list of available GMD datasets.

  2. If new datasets are found (specifically "GPWG", "GROUP", "BIN", "HIST", "ALL", "ASPIRE", and "L"), downloads them using dlw::dlw_get_gmd and save them to the local directory.

  3. Updates the inventory file (dlw_gmd_inv) with information about the newly downloaded datasets.

Usage

pipdata_get_gmd(
  inv_gmd_list = "dlw_gmd_inv",
  log = TRUE,
  save_log = TRUE,
  check_missing = TRUE,
  verbose = getOption("pipdata.verbose", default = TRUE)
)

Arguments

inv_gmd_list

Character. The name of the inventory file containing the list of GMD datasets.

log

Logical. Whether to keep logging information. Default is TRUE.

save_log

Logical. Whether to save logging information to a file. Default is TRUE.

check_missing

Logical. Whether to check for and retrieve missing data. Default is TRUE.

verbose

Logical. Controls verbosity of downstream pipload::pip_write() calls. Default: getOption("pipdata.verbose", default = TRUE).

Value

A data.table object saved in the local folder.

Note

This function expects a working release to be configured via pipfun::setup_working_release(). When called from pipdata_dlw_process(), the release is already set. When called standalone, ensure setup_working_release() has been invoked first.

Examples

if (FALSE) { # \dontrun{
pipdata_get_gmd(
  inv_gmd_list = "dlw_gmd_inv",
  log = FALSE,
  save_log = FLASE
)
} # }