# Data Validation Infrastructure

## Documentation for package ‘validate’ version 1.1.3

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Package NEWS.

## Help Pages

A B C D E F G H I K L M N O P R S V W misc

## -- A --

add_indicators | Add indicator values as columns to a data frame
aggregate-method | Aggregate validation results
all-method | Test if all validations resulted in TRUE
all_complete | Test for completeness of records
all_unique | Test for uniquenes of records
any-method | Test if any validation resulted in TRUE
as.data.frame-method | Translate cellComparison objects to data frame
as.data.frame-method | Coerce a confrontation object to data frame
as.data.frame-method | Translate an expressionset to data.frame
as.data.frame-method | Translate a validatorComparison object to data frame
as_yaml | Export to yaml file
as_yaml-method | Export to yaml file

## -- B --

barplot-method | Barplot of cellComparison object
barplot-method | Plot number of violations
barplot-method | Barplot of validatorComparison object

## -- C --

cells | Cell counts and differences for a series of datasets
check_that | Simple data validation interface
compare | Compare similar data sets
compare-method | Compare similar data sets
confront | Confront data with a (set of) expressionset(s)
confront-method | Confront data with a (set of) expressionset(s)
contains_at_least | Check records using a predifined table of (im)possible values
contains_at_most | Check records using a predifined table of (im)possible values
contains_exactly | Check records using a predifined table of (im)possible values
created | Creation timestamp
created-method | Creation timestamp
created<- | Creation timestamp
created<--method | Creation timestamp

## -- D --

description | Rule description
description-method | Rule description
description<- | Rule description
description<--method | Rule description
does_not_contain | Check records using a predifined table of (im)possible values
do_by | split-apply-combine for vectors, with equal-length outptu

## -- E --

errors | Get messages from a confrontation object
errors-method | Get messages from a confrontation object
estat_codelist | Get code list from an SDMX REST API endpoint.
event | Get or set event information metadata from a 'confrontation' object.
event-method | Get or set event information metadata from a 'confrontation' object.
event<- | Get or set event information metadata from a 'confrontation' object.
event<--method | Get or set event information metadata from a 'confrontation' object.
exists_any | Test for (unique) existence
exists_one | Test for (unique) existence
export_yaml | Export to yaml file
export_yaml-method | Export to yaml file

## -- F --

field_format | Check whether a field conforms to a regular expression
field_length | Check number of code points

## -- G --

glob | Label objects for interpretation as pattern
global_codelist | Get code list from an SDMX REST API endpoint.

## -- H --

hb | Hiridoglu-Berthelot function
hierarchy | Check aggregates defined by a hierarchical code list

## -- I --

in_linear_sequence | Check whether a variable represents a linear sequence
in_linear_sequence.character | Check whether a variable represents a linear sequence
in_linear_sequence.Date | Check whether a variable represents a linear sequence
in_linear_sequence.numeric | Check whether a variable represents a linear sequence
in_linear_sequence.POSIXct | Check whether a variable represents a linear sequence
in_range | Check variable range
in_range.character | Check variable range
in_range.default | Check variable range
is_complete | Test for completeness of records
is_linear_sequence | Check whether a variable represents a linear sequence
is_linear_sequence.character | Check whether a variable represents a linear sequence
is_linear_sequence.Date | Check whether a variable represents a linear sequence
is_linear_sequence.numeric | Check whether a variable represents a linear sequence
is_linear_sequence.POSIXct | Check whether a variable represents a linear sequence
is_unique | Test for uniquenes of records

## -- K --

keyset | Get key set stored with a confrontation
keyset-method | Get key set stored with a confrontation

## -- L --

label | Rule label
label-method | Rule label
label<- | Rule label
label<--method | Rule label
lacking | Select records (not) satisfying rules
lbj_cells | Logging object to use with the lumberjack package
lbj_cells-class | Logging object to use with the lumberjack package
lbj_rules | Logging object to use with the lumberjack package
lbj_rules-class | Logging object to use with the lumberjack package
length-method | Determine the number of elements in an object.

## -- M --

match_cells | Create matching subsets of a sequence of data
max_by | split-apply-combine for vectors, with equal-length outptu
mean_by | split-apply-combine for vectors, with equal-length outptu
meta | Get or set rule metadata
meta-method | Get or set rule metadata
meta<- | Get or set rule metadata
meta<--method | Get or set rule metadata
min_by | split-apply-combine for vectors, with equal-length outptu

## -- N --

nace_rev2 | NACE classification code table
names-method | Extract or set names
names<--method | Extract or set names
number_format | Check the layouts of numbers.
n_unique | Test for uniquenes of records

## -- O --

origin | Origin of rules
origin-method | Origin of rules
origin<- | Origin of rules
origin<--method | Origin of rules

## -- P --

package-validate | Data Validation Infrastructure
part_whole_relation | Test whether details combine to a chosen aggregate
plot-method | Line graph of a cellComparison object.
plot-method | Plot validation results
plot-method | Plot a validator object
plot-method | Line graph of validatorComparison object
print.validations | Run a file with confrontations. Capture results

## -- R --

reset | Set or get options globally or per object.
reset-method | Set or get options globally or per object.
retailers | data on Dutch supermarkets
run_validation_dir | Run a file with confrontations. Capture results
run_validation_file | Run a file with confrontations. Capture results
rx | Label objects for interpretation as pattern

## -- S --

samplonomy | Economic data on Samplonia
satisfying | Select records (not) satisfying rules
SBS2000 | data on Dutch supermarkets
sdmx_codelist | Get code list from an SDMX REST API endpoint.
sdmx_endpoint | Get URL for known SDMX registry endpoints
sort-method | Aggregate and sort the results of a validation.
summary | Create a summary
summary-method | Create a summary
summary.validations | Run a file with confrontations. Capture results
sum_by | split-apply-combine for vectors, with equal-length outptu
syntax | Syntax to define validation or indicator rules

## -- V --

validate | Data Validation Infrastructure
validate-summary | Create a summary
validate_options | Set or get options globally or per object.
validation | Store results of evaluating validating expressions
validation-class | Store results of evaluating validating expressions
validator | Define validation rules for data
validator_from_dsd | Extract a rule set from an SDMX DSD file
values | Get values from object
values-method | Get values from object
variables | Get variable names
variables-method | Get variable names
violating | Select records (not) satisfying rules
voptions | Set or get options globally or per object.
voptions-method | Set or get options globally or per object.

## -- W --

warnings-method | Get messages from a confrontation object

## -- misc --

%vin% | A consistent set membership operator
+-method | Combine two indicator objects
+-method | Combine two validator objects