ddi_setAvail: setAvail and its children

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

setAvail and its children

Description

Information on availability and storage of the data set collection. More information on this element, especially the allowed attributes, can be found in the references.

Usage

ddi_setAvail(...)

ddi_accsPlac(...)

ddi_avlStatus(...)

ddi_collSize(...)

ddi_complete(...)

ddi_fileQnty(...)

ddi_origArch(...)

Arguments

...	Child nodes or attributes.

Details

Parent node

setAvail is contained in dataAccs.

setAvail specific child nodes

ddi_accsPlac() is the location where the data collection is currently stored. Use the URI attribute to provide a URN or URL for the storage site or the actual address from which the data may be downloaded.

ddi_avlStatus() is the statement of collection availability. An archive may need to indicate that a collection is unavailable because it is embargoed for a period of time, because it has been superseded, because a new edition is imminent, etc.

ddi_collSize() summarizes the number of physical files that exist in a collection, recording the number of files that contain data and noting whether the collection contains machine-readable documentation and/or other supplementary files and information such as data dictionaries, data definition statements, or data collection instruments.

ddi_complete() is the completeness of study stored. This item indicates the relationship of the data collected to the amount of data coded and stored in the data collection. Information as to why certain items of collected information were not included in the data file stored by the archive should be provided.

ddi_fileQnty() is the total number of physical files associated with a collection.

ddi_origArch() is the archive from which the data collection was obtained; the originating archive.

Value

A ddi_node object.

Shared and complex child nodes

• ddi_notes()

References

setAvail documentation

accsPlac documentation

avlStatus documentation

collSize documentation

complete documentation

fileQnty documentation

origArch documentation

Examples

ddi_setAvail()

# Functions that need to be wrapped in ddi_setAvail()

ddi_accsPlac(URI = "https://dataverse.harvard.edu/",
             "Harvard Dataverse")

ddi_avlStatus("This collection is superseded by CENSUS OF POPULATION, 1880...")

ddi_collSize("1 data file + machine-readable documentation (PDF) + SAS data definition statements.")

ddi_complete("Because of embargo provisions, data values for some variables have been masked...")

ddi_fileQnty("5 files")

ddi_origArch("Zentralarchiv fuer empirische Sozialforschung")

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