ddi_sampleFrame: sampleFrame and its children

In Global-TIES-for-Children/rddi: R Interface to DDI Codebook 2.5

sampleFrame and its children

Description

Sample frame describes the sampling frame used for identifying the population from which the sample was taken. More information on these elements, especially their allowed attributes, can be found in the references.

Usage

ddi_sampleFrame(...)

ddi_custodian(...)

ddi_referencePeriod(...)

ddi_sampleFrameName(...)

ddi_updateProcedure(...)

ddi_validPeriod(...)

Arguments

...	Child nodes or attributes.

Details

Parent nodes

sampleFrame is contained in dataColl.

sampleFrame specific child nodes

• ddi_custodian() identifies the agency or individual who is responsible for creating or maintaining the sample frame.

• ddi_referencePeriod() indicates the period of time in which the sampling frame was actually used for the study in question. Use ISO 8601 date/time formats to enter the relevant date(s).

• ddi_sampleFrameName() is the name of the sample frame.

• ddi_updateProcedure() is the description of how and with what frequency the sample frame is updated.

• ddi_validPeriod() defines a time period for the validity of the sampling frame. Enter dates in YYYY-MM-DD format.

Value

A ddi_node object.

Shared and complex child nodes

• ddi_frameUnit()

• ddi_labl()

• ddi_txt()

• ddi_universe()

• ddi_useStmt()

References

sampleFrame documentation

custodian documentation

referencePeriod documentation

sampleFrameName documentation

updateProcedure documentation

validPeriod documentation

Examples

ddi_sampleFrame()

# Functions that need to be wrapped in ddi_sampleFrame()

ddi_custodian("DEX Publications")

ddi_referencePeriod(event = "single",
                    "2009-06-01")

ddi_sampleFrameName("City of St. Paul Directory")

ddi_updateProcedure("Changes are collected as they occur through registration 
                    and loss of phone number from the specified geographic 
                    area. Data are compiled for the date June 1st of odd 
                    numbered years, and published on July 1st for the following 
                    two-year period.")

ddi_validPeriod(event = "start", "2009-07-01")

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