dataquieR (version 2.0.1)

summary.dataquieR_resultset: Summarize a dataquieR report

Description

Summarizes a dataquieR report extracting all GRADING results.

Usage

# S3 method for dataquieR_resultset
summary(
  object,
  aspect = c("issue", "applicability", "error"),
  return_the_value = TRUE,
  ...
)

Value

a data.frame with one row per variable and one column per GRADING

result. Each function providing a GRADING conforming to the standards is represented by a column. GRADING expresses the presence of a problem with 0 = no | 1 = yes

Arguments

object

dataquieR report.

aspect

what sort of issues to summarize

return_the_value

logical return the GRADING or error message, a color otherwise.

...

not used yet.

Examples

if (FALSE) {
# runs spuriously slow on rhub
load(system.file("extdata/meta_data.RData", package = "dataquieR"), envir =
  environment())
load(system.file("extdata/study_data.RData", package = "dataquieR"), envir =
  environment())
report <- suppressWarnings(dq_report(
  variables = head(meta_data[[LABEL]], 5),
  study_data, meta_data,
  cores = 1,
  label_col = LABEL, dimensions =
  c( # for sake of speed, omit Accuracy here
       "Consistency")
))
x <- summary(report)
}