sort-validation-method: Aggregate and sort the results of a validation.

sort,validation-methodR Documentation

Aggregate and sort the results of a validation.

Description

Aggregate and sort the results of a validation.

Usage

## S4 method for signature 'validation'
sort(x, decreasing = FALSE, by = c("rule", "record"), drop = TRUE, ...)

Arguments

x

An object of class validation

decreasing

Sort by decreasing number of passes?

by

Report on violations per rule (default) or per record?

drop

drop list attribute if the result has a single argument.

...

Arguments to be passed to or from other methods.

Value

A data.frame with the following columns.

keys If confront was called with key=
npass Number of items passed
nfail Number of items failing
nNA Number of items resulting in NA
rel.pass Relative number of items passed
rel.fail Relative number of items failing
rel.NA Relative number of items resulting in NA

If by='rule' the relative numbers are computed with respect to the number of records for which the rule was evaluated. If by='record' the relative numbers are computed with respect to the number of rules the record was tested agains. By default the most failed validations and records with the most fails are on the top.

When by='record' and not all validation results have the same dimension structure, a list of data.frames is returned.

See Also

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, summary(), validation-class, values()

Examples


data(retailers)
retailers$id <- paste0("ret",1:nrow(retailers))
v <- validator(
    staff.costs/staff < 25
  , turnover + other.rev==total.rev)

cf <- confront(retailers,v,key="id")
a <- aggregate(cf,by='record')
head(a)

# or, get a sorted result:
s <- sort(cf, by='record')
head(s)



validate documentation built on March 24, 2022, 5:07 p.m.