validate (version 0.2.6)

summary: Create a summary

Description

Create a summary

Usage

summary(object, ...)
# S4 method for expressionset
summary(object, ...)
# S4 method for indication
summary(object, ...)
# S4 method for 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, indication-class

Other validation-methods: aggregate,validation-method, all,validation-method, any,validation-method, barplot,validation-method, check_that, compare, confront, plot,validation-method, sort,validation-method, validation-class, values

Examples

# NOT RUN {
data(retailers)
v <- validator(staff > 0, staff.costs/staff < 20, turnover+other.revenue == total.revenue)
summary(v)

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


# }

Run the code above in your browser using DataCamp Workspace