validate_objects: Validate input IDF data in terms of various aspects

validate_objectsR Documentation

Validate input IDF data in terms of various aspects

Description

Validate input IDF data in terms of various aspects

Usage

validate_objects(
  idd_env,
  idf_env,
  dt_object = NULL,
  dt_value = NULL,
  required_object = FALSE,
  unique_object = FALSE,
  unique_name = FALSE,
  extensible = FALSE,
  required_field = FALSE,
  auto_field = FALSE,
  type = FALSE,
  choice = FALSE,
  range = FALSE,
  reference = FALSE
)

Arguments

idd_env

An environment that contains IDD data

idf_env

An environment that contains IDF data

dt_object

A data.table that contains object data to validate. If NULL, the object data from idf_env will be used, which means to validate the whole IDF.

dt_value

A data.table that contains value data to validate. If NULL, the value data from idf_env will be used, which means to validate the whole IDF.

required_object

Whether to check if required objects are missing. This will only be applied when checking the whole IDF.

unique_object

Whether to check if there are multiple instances of unique object.

unique_name

Whether to check if there are objects having the same name in same class.

extensible

Whether to check if there are incomplete extensible.

required_field

Whether to check if there are missing value for required fields.

auto_field

Whether to check if there are non-autosizable or non-autocalculatable fields that are assigned "autosize" or "autocalculate".

type

Whether to check if there are input values whose type are not consistent with definitions in IDD.

choice

Whether to check if there are invalid choice values.

range

Whether to check if there are numeric values that are out of ranges specified in IDD.

reference

Whether to check if there are values that have invalid references.

Value

An IdfValidity object.


eplusr documentation built on Aug. 25, 2023, 5:18 p.m.