Skip to contents

Summarize the evaluate quality report

Source: R/read_evaluate_report_summary.R
read_evaluate_report_summary.Rd

Summarize the evaluate quality report

Usage

read_evaluate_report_summary(
  transaction,
  with_exceptions = TRUE,
  env = "production"
)

Arguments

transaction

(character) Transaction identifier

with_exceptions

(logical) Convert quality report warnings and errors to R warnings and errors

env

(character) Repository environment. Can be: "production", "staging", or "development".

Value

(message/warning/error) A message listing the total number of checks resulting in valid, info, warn, and error status. Exceptions are raised if warnings and errors are found and with_exceptions is TRUE.

Details

Get transaction from evaluate_data_package()

Note

User authentication is required (see login())

See also

Other Accessing: read_data_entity_checksum(), read_data_entity_names(), read_data_entity_name(), read_data_entity_resource_metadata(), read_data_entity_sizes(), read_data_entity_size(), read_data_entity(), read_data_package_archive(), read_data_package_citation(), read_data_package_doi(), read_data_package_error(), read_data_package_from_doi(), read_data_package_report_checksum(), read_data_package_report_resource_metadata(), read_data_package_report_summary(), read_data_package_report(), read_data_package_resource_metadata(), read_data_package(), read_evaluate_report(), read_metadata_checksum(), read_metadata_dublin_core(), read_metadata_entity(), read_metadata_format(), read_metadata_resource_metadata(), read_metadata()

Examples

if (FALSE) {

login()

# Evaluate data package
transaction <- evaluate_data_package(
  eml = paste0(tempdir(), "/edi.595.1.xml"),
  env = "staging"
)
transaction
#> [1] "evaluate_163966785813042760"


# Summarize report
read_evaluate_report_summary(transaction, env = "staging")
#> ===================================================
#>   EVALUATION REPORT
#> ===================================================
#>
#> PackageId: edi.595.1
#> Report Date/Time: 2021-12-16T22:49:25
#> Total Quality Checks: 29
#> Valid: 21
#> Info: 8
#> Warn: 0
#> Error: 0


logout()
}