constraints.checkMinimum: Check if minimum constraint is met

In tableschema.r: Table Schema 'Frictionless Data'

Check if minimum constraint is met

Description

Specifies a minimum value for a field. This is different to minLength which checks the number of items in the value. A minimum value constraint checks whether a field value is greater than or equal to the specified value. The range checking depends on the type of the field. E.g. an integer field may have a minimum value of 100. If a minimum value constraint is specified then the field descriptor MUST contain a type key.

Usage

constraints.checkMinimum(constraint, value)

Arguments

constraint	numeric constraint value
value	numeric value to meet the constraint

Value

TRUE if value is equal to or greater than the constraint

See Also

Constraints specifications

Examples

constraints.checkMinimum(constraint = list(2), value = 1)

constraints.checkMinimum(constraint = 2, value = 3)

tableschema.r documentation built on Sept. 30, 2022, 1:06 a.m.