LineItem

An R6 class to define a LineItem object. A LineItem is a single, explicitly defined characterization to appear in a Section. Derived classes exist off of LineItems

Active bindings

ordinalId

the order identifier of the line item in the table shell

sectionLabel

a label for the table shell section

lineItemLabel

a label for the line item

valueId

the id for the line item; either a codeset id, a concept id or a -999 to indicate no true id

valueDescription

the describer for the value id

domainTable

the domain table in the cdm

lineItemClass

the type of line item (ie Demographic, ConceptSet, SourceConceptSet, ConceptSetGroup, Cohort)

Methods

Public methods

Method new()

Usage

LineItem$new(
  sectionLabel,
  lineItemLabel = NA_character_,
  domainTable,
  lineItemClass,
  valueId = NA_integer_,
  valueDescription = NA_integer_,
  statistic,
  timeInterval = NULL
)

Arguments

sectionLabel

a label for the table shell section

lineItemLabel

a label for the line item

domainTable

the domain table in the cdm

lineItemClass

the type of line item (ie Demographic, ConceptSet, SourceConceptSet, ConceptSetGroup, Cohort)

valueId

the id for the line item; either a codeset id, a concept id or a -999 to indicate no true id

valueDescription

the describer for the value id

statistic

a Statistic Class object used to determine what type of analytic should be done for the line item

timeInterval

a time interval class object to determine the time frame to consider the analytic

Method getLineItemMeta()

retrieve the line item meta information

Usage

LineItem$getLineItemMeta()

Method getStatistic()

retrieve the statistic class object

Usage

LineItem$getStatistic()

Method clone()

The objects of this class are cloneable with this method.

Usage

LineItem$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.