summary_dc: Summarise Data Checks

In bd-R/bdchecks: Biodiversity 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 DataCheckFlagSet class and output is a summary table.

Usage

summary_dc(input_flag, fancy = TRUE, filtering_dt = FALSE)

Arguments

input_flag	Object of a DataCheckFlagSet class.
fancy	Should ouput be returned in a rst format.
filtering_dt	Should output be returned as a summary table.

Value

A data.frame or rst table with summary statistics

Examples

result <- perform_dc(data_bats)
# Fancy summary table (for usage in reports)
summary_dc(result)
# object of class used for data filtering data.frame
summary_dc(result, fancy = FALSE, filtering_dt = TRUE)

bd-R/bdchecks documentation built on Oct. 8, 2021, 5:10 p.m.