download_package: Download a data package (optionally with child packages)

In NCEAS/datamgmt: Data Management Utilities for Curating, Documenting, and Publishing Data

Download a data package (optionally with child packages)

Description

This function downloads all of the data objects in a data package to the local filesystem. It is particularly useful when a data package is too large to download using the web interface.

Usage

download_package(
  mn,
  resource_map_pid,
  download_directory,
  prefix_file_names = TRUE,
  download_column_metadata = FALSE,
  convert_excel_to_csv = FALSE,
  download_child_packages = TRUE,
  check_download_size = FALSE
)

Arguments

mn	(MNode) The Member Node to download from.
resource_map_pid	(chraracter) The PID of the resource map for the package to download.
download_directory	(character) The path of the directory to download the package to.
prefix_file_names	(logical) Optional. Whether to prefix file names with the package metadata identifier. This is useful when downloading files from multiple packages to one directory.
download_column_metadata	(logical) Optional. Whether to download attribute (column) metadata as csv files. If using this, then it is recommended to also set prefix_file_names = TRUE.
convert_excel_to_csv	(logical) Optional. Whether to convert Excel files to csv files. The csv files are downloaded as sheetName_excelWorkbookName.csv
download_child_packages	(logical) Optional. Whether to download data from child packages of the selected package. Defaults to TRUE.
check_download_size	(logical) Optional. Whether to check the total download size before continuing. Setting this to FALSE speeds up the function, especially when the package has many elements.

Details

Setting check_download_size to TRUE is recommended if you are uncertain of the total download size and want to avoid downloading very large data packages.

This function will also download any data objects it finds in any child data packages of the input data package. If you would only like to download data from one data package, set download_child_packages to FALSE.

Author(s)

Dominic Mullen, [e-mail]

Examples

## Not run: 
cn <- CNode("PROD")
mn <- getMNode(cn, "urn:node:ARCTIC")

download_package(mn, "resource_map_urn:uuid:2b4e4174-4e4b-4a46-8ab0-cc032eda8269",
"/home/dmullen")

## End(Not run)

NCEAS/datamgmt documentation built on June 5, 2023, 6:14 a.m.