TableChecks-class: Class 'ColumnChecks'

In jrnold/r-checker: Data frames with column and table constraints

Description

An object containing constraint checks intended to be used on a data.frame.

Usage

  TableChecks(columns = ColumnCheckList(), ...)

Arguments

columns	ColumnCheckList Column level checks
...	Data to include in the new object. Named arguments correspond to slots in the class definition.

Objects from the Class

Objects can be created by calls of the form TableChecks(...).

Slots

columns:

"ColumnCheckList". Column-level constraints.

exclusive:

"logical". If TRUE, then the data.frame can only contain the columns in columns. If FALSE, the data.frame still must contain the columns in columns, but can contain additional columns.

ordered:

"logical". If TRUE, the columns in the data.frame must appear in the same order as they are listed in columns, and those columns must be the first columns in the data.frame. If FALSE, the the columns in columns can appear anywhere in the data.frame.

exclude:

"character". A list of column names which cannot be in the data frame.

constraints:

"FunctionList". Additional arbitrary constraints. Each function must return either TRUE if the constraint is satisfied, or FALSE if it is violated.

See Also

Other Check.objects: ColumnCheckList, ColumnCheckList, ColumnChecks, ColumnChecks

Examples

showClass("TableChecks")

jrnold/r-checker documentation built on May 20, 2019, 1:04 a.m.