read_data_package_report_summary {EDIutils}R Documentation

Summarize the data package quality report

Description

Summarize the data package quality report

Usage

read_data_package_report_summary(
  packageId,
  with_exceptions = TRUE,
  env = "production"
)

Arguments

packageId

(character) Data package 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.

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(), read_data_package_resource_metadata(), read_data_package(), read_evaluate_report_summary(), read_evaluate_report(), read_metadata_checksum(), read_metadata_dublin_core(), read_metadata_entity(), read_metadata_format(), read_metadata_resource_metadata(), read_metadata()

Examples

## Not run: 

# Read report summary
read_data_package_report_summary("knb-lter-knz.260.4")
#> ===================================================
#>   EVALUATION REPORT
#> ===================================================
#>   
#> PackageId: knb-lter-knz.260.4
#> Report Date/Time: 2020-02-04T16:38:38
#> Total Quality Checks: 213
#> Valid: 139
#> Info: 73
#> Warn: 1
#> Error: 0
#> 
#> 
#> Warning message:
#> One or more quality checks resulted in 'warn' 

## End(Not run)

[Package EDIutils version 1.0.3 Index]