load_pkg_metadata: Loads EML-formatted metadata into R for inspection and/or...

View source: R/load_pkg_metadata.R

load_pkg_metadataR Documentation

Loads EML-formatted metadata into R for inspection and/or editing

Description

'load_pkg_metadata()' is essentially a wrapper around 'DPchecker::load_metadata' with the directory structure pre-set to work well the default location that 'get_data_package' stores downloaded data packages. If you did not use the default settings for 'get_data_package' (or downloaded a data package manually) you may find it easier to adjust the directory structure pointing to your data package and load the metadata using 'DPchecker::load_metadata()'. Much like 'load_metadata', 'load_pkg_metadata' requires that there be a single .xml file in the data package directory, that the metadata file name end in *_metadata.xml, and that the file contain schema-valid EML metadata.

Usage

load_pkg_metadata(holding_id, directory = "data")

Arguments

holding_id

is a 6-7 digit number corresponding to the holding ID of the data package zip file. Your data should be in a directory that that has the holding ID as its name.

directory

String. Path to the data package directory, defaults to "data".

Value

one data frame to the global environment.

Examples

## Not run: 
load_pgk_metadata(2266200)

## End(Not run)

nationalparkservice/DSTools documentation built on March 29, 2025, 10:54 p.m.