rddi (version 0.1.1)

ddi_stdyInfo: stdyInfo and its child nodes

Description

stdyInfo is the study scope. It contains information about the data collection's scope across several dimensions, including substantive content, geography, and time. More information on these elements, especially their allowed attributes, can be found in the references.

Usage

ddi_stdyInfo(...)
ddi_abstract(...)
ddi_studyBudget(...)

Value

A ddi_node object.

Arguments

...

Child nodes or attributes.

Shared and complex child nodes

• ddi_exPostEvaluation()

• ddi_notes()

• ddi_qualityStatement()

• ddi_subject()

• ddi_sumDscr()

Details

Parent nodes

stdyInfo is contained in stdyDscr.

stdyInfo specific child nodes

• ddi_abstract() is an unformatted summary describing the purpose, nature, and scope of the data collection, special characteristics of its contents, major subject areas covered, and what questions the PIs attempted to answer when they conducted the study. A listing of major variables in the study is important here. In cases where a codebook contains more than one abstract (for example, one might be supplied by the data producer and another prepared by the data archive where the data are deposited), the "source" and "date" attributes may be used to distinguish the abstract versions. Maps to Dublin Core Description element. Inclusion of this element in the codebook is recommended. The "date" attribute should follow ISO convention of YYYY-MM-DD.

• ddi_studyBudget()is used to describe the budget of the project in as much detail as needed.

References

stdyInfo documentation

abstract documentation

studyBudget documentation

Examples

ddi_stdyInfo()

# Functions that need to be wrapped in ddi_stdyInfo()

ddi_abstract(date = "1999-01-28",
             contentType = "abstract",
             "Data on labor force activity for the week prior to the survey 
             are supplied in this collection. Information is available on the 
             employment status, occupation, and industry of persons 15 years 
             old and over. Demographic variables such as age, sex, race, marital 
             status, veteran status, household relationship, educational 
             background, and Hispanic origin are included. In addition to 
             providing these core data, the May survey also contains a 
             supplement on work schedules for all applicable persons aged 
             15 years and older who were employed at the time of the survey. 
             This supplement focuses on shift work, flexible hours, and work 
             at home for both main and second jobs.")

ddi_studyBudget("The budget for the study covers a 5 year award period 
                distributed between direct and indirect costs including: 
                Staff, ...")