get_idd_field: Get field data

View source: R/impl-idd.R

get_idd_fieldR Documentation

Get field data

Description

Get field data

Usage

get_idd_field(
  idd_env,
  class,
  field = NULL,
  property = NULL,
  all = FALSE,
  underscore = TRUE,
  no_ext = FALSE,
  complete = FALSE
)

Arguments

idd_env

An environment or list contains IDD tables including class, field, and reference.

class

An integer vector of valid class indexes or a character vector of valid class names.

field

An integer vector of valid field indexes or a character vector of valid field names (can be in in underscore style). class and field should have the same length.

property

A character vector of column names in field table to return.

underscore

If TRUE, input class name and field names will be converted into underscore style name first and column class_name_us and field_name_us will be used for matching.

no_ext

If TRUE, no new extensible groups will be added even if there are no matched input found and an error will be issued right away.

complete

If TRUE, at least fields till the current whole extensible group will be returned. A new column named "matched_rleid" will be created (when property is NULL) indicating if given field has been matched or not.

Value

A data.table containing specified columns.


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