runCheck: Execute a quality check for a metadata document

In NCEAS/metadig-r: Author MetaDIG checks in R

Execute a quality check for a metadata document

Description

This function runs a quality check based on an XML document that conforms to the format specified with the reference implementation of the metadata quality engine: https://github.com/NCEAS/metadig-engine. The function extracts values from the metadata document as specified in the quality check document and runs the check R code to examine these values. The check returns a list providing information about the success or failure of the check.

Usage

runCheck(checkXML, metadataXML, checkFunction)

Arguments

checkXML	(character) The filepath for a quality check document.
metadataXML	(character) The filepath for a metadata document to check.
checkFunction	(not yet implemented)

Value

A named list of check results.

Examples

checkXML <- system.file("extdata/dataset_title_length-check.xml", package = "metadig")
metadataXML <- system.file("extdata/example_EML.xml", package = "metadig")
result <- runCheck(checkXML, metadataXML)

NCEAS/metadig-r documentation built on June 17, 2022, 5:09 a.m.