Package 'vrule'

Description

column_spec

column_spec

Public fields

Methods

Public methods

• column_spec$new()

• column_spec$setName()

• column_spec$setURN()

• column_spec$isDimension()

• column_spec$setAliases()

• column_spec$setRequired()

• column_spec$addRule()

• column_spec$validate()

• column_spec$hasCodelist()

• column_spec$clone()

Method new()

Initializes a column specification

Usage

column_spec$new(obj = NULL)

Arguments

Method setName()

set name

Usage

column_spec$setName(name)

Arguments

Method setURN()

set URN

Usage

column_spec$setURN(urn)

Arguments

Method isDimension()

Set if the column is a dimension

Usage

column_spec$isDimension(isDimension)

Arguments

Method setAliases()

Set aliases

Usage

column_spec$setAliases(aliases)

Arguments

Method setRequired()

Set if the column is required

Usage

column_spec$setRequired(required)

Arguments

Method addRule()

Adds a validation rule

Usage

column_spec$addRule(rule)

Arguments

Method validate()

Method to validate column data

Usage

column_spec$validate(values, rows)

Arguments

Returns

a validation report, object of class vrule_report

Method hasCodelist()

Indicates if column specification includes a codelist validation rule

Usage

column_spec$hasCodelist()

Returns

TRUE if it includes codelist validation, FALSE otherwise

Method clone()

The objects of this class are cloneable with this method.

Usage

column_spec$clone(deep = FALSE)

Arguments

Description

create_vrule_report

Usage

create_vrule_report(valid, category, rule, type, message)

Arguments

Description

decodeVrules

Usage

decodeVrules(json)

Arguments

Description

format_spec

format_spec

Public fields

Methods

Public methods

• format_spec$new()

• format_spec$setName()

• format_spec$setURN()

• format_spec$setTitle()

• format_spec$setType()

• format_spec$addColumnSpec()

• format_spec$getColumnSpecByName()

• format_spec$getColumnSpecByURN()

• format_spec$getColumnSpecByAlias()

• format_spec$getColumnSpec()

• format_spec$validateStructure()

• format_spec$validateSeries()

• format_spec$validateContent()

• format_spec$validate()

• format_spec$display_as_handsontable()

• format_spec$validate_and_display_as_handsontable()

• format_spec$standardizeStructure()

• format_spec$standardizeContent()

• format_spec$createTemplate()

• format_spec$clone()

Method new()

Initializes a format specification from a JSON list object

Usage

format_spec$new(file = NULL, obj = NULL, json = NULL)

Arguments

Method setName()

Set name

Usage

format_spec$setName(name)

Arguments

Method setURN()

Set URN

Usage

format_spec$setURN(urn)

Arguments

Method setTitle()

Set title

Usage

format_spec$setTitle(title)

Arguments

Method setType()

Set type

Usage

format_spec$setType(type)

Arguments

Method addColumnSpec()

Adds a column specification

Usage

format_spec$addColumnSpec(column_spec)

Arguments

Method getColumnSpecByName()

Get column specification by name

Usage

format_spec$getColumnSpecByName(name)

Arguments

Returns

an object of class column_spec, or NULL if no column specification is found

Method getColumnSpecByURN()

Get column specification by URN

Usage

format_spec$getColumnSpecByURN(urn)

Arguments

Returns

an object of class column_spec, or NULL if no column specification is found

Method getColumnSpecByAlias()

Get column specification by alias

Usage

format_spec$getColumnSpecByAlias(alias)

Arguments

Returns

an object of class column_spec, or NULL if no column specification is found

Method getColumnSpec()

Get column specification

Usage

format_spec$getColumnSpec(column)

Arguments

Returns

an object of class column_spec, or NULL if no column specification is found

Method validateStructure()

Applies data structure validation

Usage

format_spec$validateStructure(data)

Arguments

Returns

an object of class data.frame if any data structure validation issue is found (ERROR or WARNING), or NULL if valid

Method validateSeries()

Applies data series validation

Usage

format_spec$validateSeries(data)

Arguments

Returns

an object of class data.frame if any data series validation issue is found (ERROR or WARNING), or NULL if valid

Method validateContent()

Applies data content validation

Usage

format_spec$validateContent(
  data,
  mode = c("column", "pair"),
  parallel = FALSE,
  ...
)

Arguments

Returns

an object of class data.frame

Method validate()

Applies data validation

Usage

format_spec$validate(data, mode = c("column", "pair"), parallel = FALSE, ...)

Arguments

Returns

an object of class data.frame

Method display_as_handsontable()

Display data and validation report as Handsontable

Usage

format_spec$display_as_handsontable(data, report, ...)

Arguments

Returns

an object of class rhandsontable

Method validate_and_display_as_handsontable()

Applies data validation

Usage

format_spec$validate_and_display_as_handsontable(
  data,
  parallel = FALSE,
  read_only = TRUE,
  use_css_classes = FALSE,
  ...
)

Arguments

Returns

an object of class rhandsontable

Method standardizeStructure()

Standardize structure

Usage

format_spec$standardizeStructure(data, exclude_unused = TRUE)

Arguments

Returns

the standardized data structure

Method standardizeContent()

Standardize content

Usage

format_spec$standardizeContent(data)

Arguments

Returns

the standardized data

Method createTemplate()

Creates template based on the format specification, including a template structure and eventual reference data files (codelists)

Usage

format_spec$createTemplate(use_aliases = FALSE, dir)

Arguments

Returns

the path of the output template (as ZIP file)

Method clone()

The objects of this class are cloneable with this method.

Usage

format_spec$clone(deep = FALSE)

Arguments

Description

get the list of classes inheriting a given super class provided by its name

Usage

getClassesInheriting(classname, extended, pretty)

Arguments

Examples

getClassesInheriting("vrule_integer")

Description

get the list of validation classes, ie classes extending vrule_abstract super class, including classes eventually defined outside vrule. In case the latter is on the search path, the list of validation classes will be cached for optimized used by vrule encoder/decoder.

Usage

getVruleClasses()

Author(s)

Emmanuel Blondel, [email protected]

Examples

getVruleClasses()

Description

getVruleOption

Usage

getVruleOption(opt)

Arguments

Value

the value for that option

Description

getVruleOptions

Usage

getVruleOptions()

Description

setVruleOptions

Usage

setVruleOptions(...)

Arguments

Description

Provides tools to validate data based on business validation rules.

Author(s)

Maintainer: Emmanuel Blondel [email protected] (ORCID)

Authors:

• Alexandre Bennici [email protected] (ORCID)

See Also

Useful links:

• https://github.com/fdiwg/vrule

• https://fdiwg.github.io/vrule/

• Report bugs at https://github.com/fdiwg/vrule/issues

Description

Abstract validation rule

Abstract validation rule

Methods

Public methods

• vrule_abstract$new()

• vrule_abstract$validate()

• vrule_abstract$getType()

• vrule_abstract$getCategory()

• vrule_abstract$getName()

• vrule_abstract$clone()

Method new()

Initializes an abstract validation rule

Usage

vrule_abstract$new(..., type = c("ERROR", "WARNING"))

Arguments

Method validate()

Abstract method to validate data

Usage

vrule_abstract$validate(value, ...)

Arguments

Returns

a validation report, object of class vrule_report

Method getType()

Get validation type

Usage

vrule_abstract$getType()

Returns

ERROR or WARNING

Method getCategory()

Get validation rule category

Usage

vrule_abstract$getCategory()

Returns

the validation rule category

Method getName()

Get validation rule name

Usage

vrule_abstract$getName()

Returns

the validation rule name

Method clone()

The objects of this class are cloneable with this method.

Usage

vrule_abstract$clone(deep = FALSE)

Arguments

Description

vrule_abstract_complex

vrule_abstract_complex

Super class

vrule::vrule_abstract -> vrule_abstract_complex

Methods

Public methods

• vrule_abstract_complex$new()

• vrule_abstract_complex$validate()

• vrule_abstract_complex$clone()

Method new()

Initializes an abstract complex validation rule

Usage

vrule_abstract_complex$new(...)

Arguments

Method validate()

Abstract method to validate data

Usage

vrule_abstract_complex$validate(value, ...)

Arguments

Returns

a validation report, object of class vrule_report

Method clone()

The objects of this class are cloneable with this method.

Usage

vrule_abstract_complex$clone(deep = FALSE)

Arguments

Description

vrule_abstract_simple

vrule_abstract_simple

Super class

vrule::vrule_abstract -> vrule_abstract_simple

Methods

Public methods

• vrule_abstract_simple$new()

• vrule_abstract_simple$validate()

• vrule_abstract_simple$clone()

Method new()

Initializes an abstract simple validation rule

Usage

vrule_abstract_simple$new(...)

Arguments

Method validate()

Abstract method to validate data

Usage

vrule_abstract_simple$validate(value, ...)

Arguments

Returns

a validation report, object of class vrule_report

Method clone()

The objects of this class are cloneable with this method.

Usage

vrule_abstract_simple$clone(deep = FALSE)

Arguments

Description

vrule_character

vrule_character

Super classes

vrule::vrule_abstract -> vrule::vrule_abstract_simple -> vrule::vrule_datatype -> vrule_character

Methods

Public methods

• vrule_character$new()

• vrule_character$validate()

• vrule_character$clone()

Method new()

Initializes a character data validation rule

Usage

vrule_character$new(na_allowed = FALSE, ...)

Arguments

Method validate()

Method to validate data

Usage

vrule_character$validate(value, ...)

Arguments

Returns

a validation report, object of class vrule_report

Method clone()

The objects of this class are cloneable with this method.

Usage

vrule_character$clone(deep = FALSE)

Arguments

Description

vrule_codelist

vrule_codelist

Super classes

vrule::vrule_abstract -> vrule::vrule_abstract_simple -> vrule_codelist

Public fields

Methods

Public methods

• vrule_codelist$new()

• vrule_codelist$validate()

• vrule_codelist$clone()

Method new()

Initializes a codelist validation rule

Usage

vrule_codelist$new(
  ref_data_url = NULL,
  ref_data_column = "code",
  ref_data_column_alt = "label",
  allow_labels = FALSE,
  ref_meta_url = NULL,
  ...
)

Arguments

Method validate()

Validates value with a codelist validation rule

Usage

vrule_codelist$validate(value, ...)

Arguments

Returns

a validation report, object of class vrule_report

Method clone()

The objects of this class are cloneable with this method.

Usage

vrule_codelist$clone(deep = FALSE)

Arguments

Description

vrule_cross_column

vrule_cross_column

Super classes

vrule::vrule_abstract -> vrule::vrule_abstract_complex -> vrule_cross_column

Public fields

Methods

Public methods

• vrule_cross_column$new()

• vrule_cross_column$validate()

• vrule_cross_column$clone()

Method new()

Initializes a cross-column check validation rule

Usage

vrule_cross_column$new(operator, expr, ...)

Arguments

Method validate()

Abstract method to validate data

Usage

vrule_cross_column$validate(value, row)

Arguments

Returns

a validation report, object of class vrule_report

Method clone()

The objects of this class are cloneable with this method.

Usage

vrule_cross_column$clone(deep = FALSE)

Arguments

Description

vrule_datatype

vrule_datatype

Super classes

vrule::vrule_abstract -> vrule::vrule_abstract_simple -> vrule_datatype

Public fields

Methods

Public methods

• vrule_datatype$new()

• vrule_datatype$validate()

• vrule_datatype$clone()

Method new()

Initializes a data type validation rule

Usage

vrule_datatype$new(datatype, na_allowed = FALSE, ...)

Arguments

Method validate()

Abstract method to validate data

Usage

vrule_datatype$validate(value, ...)

Arguments

Returns

a validation report, object of class vrule_report

Method clone()

The objects of this class are cloneable with this method.

Usage

vrule_datatype$clone(deep = FALSE)

Arguments

Description

vrule_date

vrule_date

Super classes

vrule::vrule_abstract -> vrule::vrule_abstract_simple -> vrule::vrule_datatype -> vrule::vrule_character -> vrule_date

Methods

Public methods

• vrule_date$new()

• vrule_date$validate()

• vrule_date$clone()

Method new()

Initializes a date validation rule

Usage

vrule_date$new(na_allowed = FALSE, ...)

Arguments

Method validate()

Validates a date

Usage

vrule_date$validate(value, ...)

Arguments

Returns

a validation report, object of class vrule_report

Method clone()

The objects of this class are cloneable with this method.

Usage

vrule_date$clone(deep = FALSE)

Arguments

Description

vrule_date_max

vrule_date_max

Details

vrule_date_max

Super classes

vrule::vrule_abstract -> vrule::vrule_operator_binary -> vrule::vrule_operator_relational -> vrule_date_max

Methods

Public methods

• vrule_date_max$new()

• vrule_date_max$validate()

• vrule_date_max$clone()

Method new()

Initializes a date max validation rule

Usage

vrule_date_max$new(maxValue, ...)

Arguments

Method validate()

Validates data based on a max date threshold

Usage

vrule_date_max$validate(value, ...)

Arguments

Returns

a validation report, object of class vrule_report

Method clone()

The objects of this class are cloneable with this method.

Usage

vrule_date_max$clone(deep = FALSE)

Arguments

Description

vrule_date_min

vrule_date_min

Details

vrule_date_min

Super classes

vrule::vrule_abstract -> vrule::vrule_operator_binary -> vrule::vrule_operator_relational -> vrule_date_min

Methods

Public methods

• vrule_date_min$new()

• vrule_date_min$validate()

• vrule_date_min$clone()

Method new()

Initializes a date min validation rule

Usage

vrule_date_min$new(minValue, ...)

Arguments

Method validate()

Validates data based on a min date threshold

Usage

vrule_date_min$validate(value, ...)

Arguments

Returns

a validation report, object of class vrule_report

Method clone()

The objects of this class are cloneable with this method.

Usage

vrule_date_min$clone(deep = FALSE)

Arguments

Description

vrule_date_range

vrule_date_range

Details

vrule_date_range

Super classes

vrule::vrule_abstract -> vrule::vrule_abstract_simple -> vrule_date_range

Public fields

Methods

Public methods

• vrule_date_range$new()

• vrule_date_range$validate()

• vrule_date_range$clone()

Method new()

Initializes a range validation rule

Usage

vrule_date_range$new(minValue, maxValue, ...)

Arguments

Method validate()

Validates data based on a date range

Usage

vrule_date_range$validate(value, ...)

Arguments

Returns

a validation report, object of class vrule_report

Method clone()

The objects of this class are cloneable with this method.

Usage

vrule_date_range$clone(deep = FALSE)

Arguments

Description

vrule_date_threshold

vrule_date_threshold

Details

vrule_date_threshold

Super classes

vrule::vrule_abstract -> vrule::vrule_operator_binary -> vrule::vrule_operator_relational -> vrule_date_threshold

Methods

Public methods

• vrule_date_threshold$new()

• vrule_date_threshold$validate()

• vrule_date_threshold$clone()

Method new()

Initializes a date threshold validation rule

Usage

vrule_date_threshold$new(operator, threshold, ...)

Arguments

Method validate()

Validates data based on a date threshold

Usage

vrule_date_threshold$validate(value, ...)

Arguments

Returns

a validation report, object of class vrule_report

Method clone()

The objects of this class are cloneable with this method.

Usage

vrule_date_threshold$clone(deep = FALSE)

Arguments

Description

vrule_double

vrule_double

Super classes

vrule::vrule_abstract -> vrule::vrule_abstract_simple -> vrule::vrule_datatype -> vrule_double

Methods

Public methods

• vrule_double$new()

• vrule_double$validate()

• vrule_double$clone()

Method new()

Initializes a double data validation rule

Usage

vrule_double$new(na_allowed = FALSE, ...)

Arguments

Method validate()

Method to validate data

Usage

vrule_double$validate(value, ...)

Arguments

Returns

a validation report, object of class vrule_report

Method clone()

The objects of this class are cloneable with this method.

Usage

vrule_double$clone(deep = FALSE)

Arguments

Description

vrule_if

vrule_if

Super classes

vrule::vrule_abstract -> vrule::vrule_abstract_complex -> vrule_if

Public fields

Methods

Public methods

• vrule_if$new()

• vrule_if$validate()

• vrule_if$clone()

Method new()

Initializes a conditionnal validation rule

Usage

vrule_if$new(if_condition, then_apply = list(), else_apply = list(), ...)

Arguments

Method validate()

Abstract method to validate data

Usage

vrule_if$validate(value, row)

Arguments

Returns

a validation report, object of class vrule_report

Method clone()

The objects of this class are cloneable with this method.

Usage

vrule_if$clone(deep = FALSE)

Arguments

Description

vrule_integer

vrule_integer

Super classes

vrule::vrule_abstract -> vrule::vrule_abstract_simple -> vrule::vrule_datatype -> vrule_integer

Methods

Public methods

• vrule_integer$new()

• vrule_integer$validate()

• vrule_integer$clone()

Method new()

Initializes a integer data validation rule

Usage

vrule_integer$new(na_allowed = FALSE, ...)

Arguments

Method validate()

Method to validate data

Usage

vrule_integer$validate(value, ...)

Arguments

Returns

a validation report, object of class vrule_report

Method clone()

The objects of this class are cloneable with this method.

Usage

vrule_integer$clone(deep = FALSE)

Arguments

Description

vrule_logical

vrule_logical

Super classes

vrule::vrule_abstract -> vrule::vrule_abstract_simple -> vrule::vrule_datatype -> vrule_logical

Methods

Public methods

• vrule_logical$new()

• vrule_logical$validate()

• vrule_logical$clone()

Method new()

Initializes a logical data validation rule

Usage

vrule_logical$new(na_allowed = FALSE, ...)

Arguments

Method validate()

Method to validate data

Usage

vrule_logical$validate(value, ...)

Arguments

Returns

a validation report, object of class vrule_report

Method clone()

The objects of this class are cloneable with this method.

Usage

vrule_logical$clone(deep = FALSE)

Arguments

Description

vrule_mapping

vrule_mapping

Super classes

vrule::vrule_abstract -> vrule::vrule_abstract_complex -> vrule_mapping

Public fields

Methods

Public methods

• vrule_mapping$new()

• vrule_mapping$validate()

• vrule_mapping$clone()

Method new()

Initializes a mapping-based validation rule

Usage

vrule_mapping$new(
  ref_data_url = NULL,
  ref_source_term = NULL,
  ref_target_term = NULL,
  data_target_term = NULL,
  ref_meta_url = NULL,
  ...
)

Arguments

Method validate()

Abstract method to validate data

Usage

vrule_mapping$validate(value, row)

Arguments

Returns

a validation report, object of class vrule_report

Method clone()

The objects of this class are cloneable with this method.

Usage

vrule_mapping$clone(deep = FALSE)

Arguments

Description

vrule_max

vrule_max

Details

vrule_max

Super classes

vrule::vrule_abstract -> vrule::vrule_operator_binary -> vrule::vrule_operator_relational -> vrule_max

Methods

Public methods

• vrule_max$new()

• vrule_max$validate()

• vrule_max$clone()

Method new()

Initializes a max threshold validation rule

Usage

vrule_max$new(maxValue, ...)

Arguments

Method validate()

Validates data based on a max threshold

Usage

vrule_max$validate(value, ...)

Arguments

Returns

a validation report, object of class vrule_report

Method clone()

The objects of this class are cloneable with this method.

Usage

vrule_max$clone(deep = FALSE)

Arguments

Description

vrule_min

vrule_min

Details

vrule_min

Super classes

vrule::vrule_abstract -> vrule::vrule_operator_binary -> vrule::vrule_operator_relational -> vrule_min

Methods

Public methods

• vrule_min$new()

• vrule_min$validate()

• vrule_min$clone()

Method new()

Initializes a min threshold validation rule

Usage

vrule_min$new(minValue, ...)

Arguments

Method validate()

Validates data based on a min threshold

Usage

vrule_min$validate(value, ...)

Arguments

Returns

a validation report, object of class vrule_report

Method clone()

The objects of this class are cloneable with this method.

Usage

vrule_min$clone(deep = FALSE)

Arguments

Description

vrule_numeric

vrule_numeric

Super classes

vrule::vrule_abstract -> vrule::vrule_abstract_simple -> vrule::vrule_datatype -> vrule_numeric

Methods

Public methods

• vrule_numeric$new()

• vrule_numeric$validate()

• vrule_numeric$clone()

Method new()

Initializes a numeric data validation rule

Usage

vrule_numeric$new(na_allowed = FALSE, ...)

Arguments

Method validate()

Method to validate data

Usage

vrule_numeric$validate(value, ...)

Arguments

Returns

a validation report, object of class vrule_report

Method clone()

The objects of this class are cloneable with this method.

Usage

vrule_numeric$clone(deep = FALSE)

Arguments

Description

vrule_operator_and

vrule_operator_and

Super classes

vrule::vrule_abstract -> vrule::vrule_operator_binary -> vrule::vrule_operator_logical -> vrule_operator_and

Methods

Public methods

• vrule_operator_and$new()

• vrule_operator_and$validate()

• vrule_operator_and$clone()

Method new()

Initializes a logical AND operator validation rule

Usage

vrule_operator_and$new(...)

Arguments

Method validate()

Method to validate data

Usage

vrule_operator_and$validate(value, row)

Arguments

Returns

a validation report, object of class vrule_report

Method clone()

The objects of this class are cloneable with this method.

Usage

vrule_operator_and$clone(deep = FALSE)

Arguments

Description

vrule_operator_binary

vrule_operator_binary

Super class

vrule::vrule_abstract -> vrule_operator_binary

Public fields

Methods

Public methods

• vrule_operator_binary$new()

• vrule_operator_binary$validate()

• vrule_operator_binary$clone()

Method new()

Initializes a binary operator validation rule

Usage

vrule_operator_binary$new(operator, expr, ...)

Arguments

Method validate()

Method to validate data

Usage

vrule_operator_binary$validate(value, ...)

Arguments

Returns

a validation report, object of class vrule_report

Method clone()

The objects of this class are cloneable with this method.

Usage

vrule_operator_binary$clone(deep = FALSE)

Arguments

Description

vrule_operator_logical

vrule_operator_logical

Super classes

vrule::vrule_abstract -> vrule::vrule_operator_binary -> vrule_operator_logical

Public fields

Methods

Public methods

• vrule_operator_logical$new()

• vrule_operator_logical$validate()

• vrule_operator_logical$clone()

Method new()

Initializes a logical operator validation rule

Usage

vrule_operator_logical$new(operator, ...)

Arguments

Method validate()

Method to validate data

Usage

vrule_operator_logical$validate(value, row)

Arguments

Returns

a validation report, object of class vrule_report

Method clone()

The objects of this class are cloneable with this method.

Usage

vrule_operator_logical$clone(deep = FALSE)

Arguments

Description

vrule_operator_or

vrule_operator_or

Super classes

vrule::vrule_abstract -> vrule::vrule_operator_binary -> vrule::vrule_operator_logical -> vrule_operator_or

Methods

Public methods

• vrule_operator_or$new()

• vrule_operator_or$validate()

• vrule_operator_or$clone()

Method new()

Initializes a logical OR operator validation rule

Usage

vrule_operator_or$new(...)

Arguments

Method validate()

Method to validate data

Usage

vrule_operator_or$validate(value, row)

Arguments

Returns

a validation report, object of class vrule_report

Method clone()

The objects of this class are cloneable with this method.

Usage

vrule_operator_or$clone(deep = FALSE)

Arguments

Description

vrule_operator_relational

vrule_operator_relational

Details

vrule_operator_relational

Super classes

vrule::vrule_abstract -> vrule::vrule_operator_binary -> vrule_operator_relational

Methods

Public methods

• vrule_operator_relational$new()

• vrule_operator_relational$validate()

• vrule_operator_relational$clone()

Method new()

Initializes a operator relational validation rule

Usage

vrule_operator_relational$new(operator, expr, ...)

Arguments

Method validate()

Abstract method to validate data

Usage

vrule_operator_relational$validate(value, ...)

Arguments

Returns

a validation report, object of class vrule_report

Method clone()

The objects of this class are cloneable with this method.

Usage

vrule_operator_relational$clone(deep = FALSE)

Arguments

Description

vrule_range

vrule_range

Details

vrule_range

Super classes

vrule::vrule_abstract -> vrule::vrule_abstract_simple -> vrule_range

Public fields

Methods

Public methods

• vrule_range$new()

• vrule_range$validate()

• vrule_range$clone()

Method new()

Initializes a range validation rule

Usage

vrule_range$new(minValue, maxValue, ...)

Arguments

Method validate()

Validates data based on a range

Usage

vrule_range$validate(value, ...)

Arguments

Returns

a validation report, object of class vrule_report

Method clone()

The objects of this class are cloneable with this method.

Usage

vrule_range$clone(deep = FALSE)

Arguments

Description

vrule_raw_codelist

vrule_raw_codelist

Super classes

vrule::vrule_abstract -> vrule::vrule_abstract_simple -> vrule_raw_codelist

Public fields

Methods

Public methods

• vrule_raw_codelist$new()

• vrule_raw_codelist$validate()

• vrule_raw_codelist$clone()

Method new()

Initializes a raw codelist validation rule

Usage

vrule_raw_codelist$new(ref_values = NULL, ...)

Arguments

Method validate()

Validates value with a raw codelist validation rule

Usage

vrule_raw_codelist$validate(value, ...)

Arguments

Returns

a validation report, object of class vrule_report

Method clone()

The objects of this class are cloneable with this method.

Usage

vrule_raw_codelist$clone(deep = FALSE)

Arguments

Description

vrule_report

vrule_report

Public fields

Methods

Public methods

• vrule_report$new()

• vrule_report$clone()

Method new()

Initializes a validation report

Usage

vrule_report$new(valid = NULL, report = NULL)

Arguments

Method clone()

The objects of this class are cloneable with this method.

Usage

vrule_report$clone(deep = FALSE)

Arguments

Description

vrule_threshold

vrule_threshold

Details

vrule_threshold

Super classes

vrule::vrule_abstract -> vrule::vrule_operator_binary -> vrule::vrule_operator_relational -> vrule_threshold

Methods

Public methods

• vrule_threshold$new()

• vrule_threshold$validate()

• vrule_threshold$clone()

Method new()

Initializes a threshold validation rule

Usage

vrule_threshold$new(operator, threshold, ...)

Arguments

Method validate()

Validates data based on a threshold

Usage

vrule_threshold$validate(value, ...)

Arguments

Returns

a validation report, object of class vrule_report

Method clone()

The objects of this class are cloneable with this method.

Usage

vrule_threshold$clone(deep = FALSE)

Arguments

Description

vrule_year

vrule_year

Super classes

vrule::vrule_abstract -> vrule::vrule_abstract_simple -> vrule::vrule_datatype -> vrule::vrule_integer -> vrule_year

Methods

Public methods

• vrule_year$new()

• vrule_year$validate()

• vrule_year$clone()

Method new()

Initializes a year validation rule

Usage

vrule_year$new(na_allowed = FALSE, ...)

Arguments

Method validate()

Validates a year

Usage

vrule_year$validate(value, ...)

Arguments

Returns

a validation report, object of class vrule_report

Method clone()

The objects of this class are cloneable with this method.

Usage

vrule_year$clone(deep = FALSE)

Arguments