qa_package: Check package including congruence of attributes and data

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

Check package including congruence of attributes and data

Description

This function checks that the attributes listed in the metadata match the values in the data for each tabular data object. It may also optionally check if all creators have ORCIDs and have full access to all elements of the data package.

Usage

qa_package(
  mn,
  resource_map_pid,
  read_all_data = TRUE,
  check_attributes = TRUE,
  check_creators = FALSE,
  check_access = FALSE
)

Arguments

mn	(MNode) The Member Node to query.
resource_map_pid	(character) The PID for a resource map.
read_all_data	(logical) Read all data from remote and check that column types match attributes. If FALSE, only read first 10 rows. Only applicable to public packages (private packages will read complete dataset). If check_attributes = FALSE, no rows will be read.
check_attributes	(logical) Check congruence of attributes and data.
check_creators	(logical) Check if each creator has an ORCID. Will also run if check_access = TRUE.
check_access	(logical) Check if each creator has full access to the metadata, resource map, and data objects. Will not run if the checks associated with check_creators fail.

Value

NULL

Examples

## Not run: 
# Run all QA checks

qa_package(mn, pid, read_all_data = TRUE, check_attributes = TRUE,
           check_creators = TRUE, check_access = TRUE)

## End(Not run)

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