ddi_dataItem: dataItem and its child nodes

View source: R/locMap.R

ddi_dataItemR Documentation

dataItem and its child nodes

Description

Identifies a physical storage location for an individual data entry, serving as a link between the physical location and the logical content description of each data item. . It is used to describe the physical location of aggregate/tabular data in cases where the nCube model is employed. More information on these elements, especially their allowed attributes, can be found in the references.

Usage

ddi_dataItem(...)

ddi_CubeCoord(...)

ddi_physLoc(...)

Arguments

...

Child nodes or attributes.

Details

Parent nodes

dataItem is contained in locMap.

dataItem specific child nodes

  • ddi_CubeCoord() is an empty element containing only the attributes listed below. It is used to identify the coordinates of the data item within a logical nCube describing aggregate data. CubeCoord is repeated for each dimension of the nCube giving the coordinate number ("coordNo") and coordinate value ("coordVal"). Coordinate value reference ("cordValRef") is an ID reference to the variable that carries the coordinate value. The attributes provide a complete coordinate location of a cell within the nCube.

  • ddi_physLoc() is an empty element containing only the attributes listed below. Attributes include "type" (type of file structure: rectangular, hierarchical, two-dimensional, relational), "recRef" (IDREF link to the appropriate file or recGrp element within a file), "startPos" (starting position of variable or data item), "endPos" (ending position of variable or data item), "width" (number of columns the variable/data item occupies), "RecSegNo" (the record segment number, deck or card number the variable or data item is located on), and "fileid" (an IDREF link to the fileDscr element for the file that includes this physical location).

Value

A ddi_node object.

References

dataItem documentation

CubeCoord documentation

physLoc documentation

Examples

ddi_dataItem()

# Functions that need to be wrapped in ddi_dataItem()

ddi_CubeCoord(coordNo = "1", coordVal = "3")

ddi_physLoc(type = "rectangular", 
            recRef = "R1",
            startPos = "55",
            endPos = "57",
            width = "3")


Global-TIES-for-Children/rddi documentation built on Oct. 24, 2022, 9:50 p.m.