summary.dataquieR_resultset: Summarize a dataquieR report

Description Usage Arguments Value Examples

View source: R/summary.dataquieR_resultset.R

Description

Summarizes a dataquieR report extracting all GRADING results.

Usage

1
2
## S3 method for class 'dataquieR_resultset'
summary(object, ...)

Arguments

object

dataquieR report.

...

not used yet.

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

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
## Not run: 
# 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)

## End(Not run)

dataquieR documentation built on Feb. 26, 2021, 5:08 p.m.