runSuite: Execute a quality suite for a metadata document

View source: R/runSuite.R

runSuiteR Documentation

Execute a quality suite for a metadata document

Description

This function runs a suite of quality checks based on an XML document that conforms to the format specified with the reference implementation of the metadata quality engine: https://github.com/NCEAS/mdqengine.

Usage

runSuite(suiteXML, dirXML, metadataXML)

Arguments

suiteXML

(character) A filepath for the quality suite document.

dirXML

(character) A filepath for the directory storing quality check documents.

metadataXML

(character) A filepath for the metadata document to check.

Value

A named list of results.

Examples

## Not run: 
metadataXML <- system.file("extdata/example_EML.xml", package = "metadig")
suiteXML <- system.file("extdata/example_suite.xml", package = "metadig")
dirXML <- systemfile("extdata", package = "metadig")

results <- runSuite(suiteXML, dirXML, metadataXML)

## End(Not run)

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