summary_DC {bdchecks}R Documentation

Summarise Data Checks

Description

'summary_DC()' is a function that calculated statistics for how many data checks passed. It's main input is an object of a dataCheckFlag class and output is a summary table.

Usage

summary_DC(inputFlag, fancy = TRUE, filteringDT = FALSE)

Arguments

inputFlag

Object of a dataCheckFlag class

fancy

Should ouput be returned in a rst format

filteringDT

Should output be returned as a summary table that could be parsed with a 'DT' pacakge

Value

A data.frame or rst table with summary statistics

Examples

result <- performDataCheck(dataBats)
# Fancy summary table (for usage in reports)
summary_DC(result)
# object of class used for data filtering data.frame
summary_DC(result, fancy = FALSE, filteringDT = TRUE)


[Package bdchecks version 0.1.7 Index]