validate-summary: Create a summary

Description Usage Arguments Value Validator and indicator objects Indication Validation See Also Examples

Description

Create a summary

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
summary(object, ...)

## S4 method for signature 'expressionset'
summary(object, ...)

## S4 method for signature 'indication'
summary(object, ...)

## S4 method for signature 'validation'
summary(object, ...)

Arguments

object

An R object

...

Currently unused

Value

A data.frame with the information mentioned below is returned.

Validator and indicator objects

For these objects, the ruleset is split into subsets (blocks) that are disjunct in the sense that they do not share any variables. For each block the number of variables, the number of rules and the number of rules that are linear are reported.

Indication

Some basic information per evaluated indicator is reported: the number of items to which the indicator was applied, the output class, some statistics (min, max, mean , number of NA) and wether an exception occurred (warnings or errors). The evaluated expression is reported as well.

Validation

Some basic information per evaluated validation rule is reported: the number of items to which the rule was applied, the output class, some statistics (passes, fails, number of NA) and wether an exception occurred (warnings or errors). The evaluated expression is reported as well.

See Also

plot,validator-method

Other expressionset-methods: as.data.frame,expressionset-method, as.data.frame(), created(), description(), label(), meta(), names<-,rule,character-method, origin(), plot,validator-method, variables(), voptions()

Other indication-methods: confront(), event(), indication-class

Other validation-methods: aggregate,validation-method, all,validation-method, any,validation-method, barplot,validation-method, check_that(), compare(), confront(), event(), names<-,rule,character-method, plot,validation-method, sort,validation-method, validation-class, values()

Examples

1
2
3
4
5
6
data(retailers)
v <- validator(staff > 0, staff.costs/staff < 20, turnover+other.revenue == total.revenue)
summary(v)

cf <- confront(retailers,v)
summary(cf)

validate documentation built on Oct. 7, 2021, 9:19 a.m.