[Mirrored from: http://www.icpsr.umich.edu/DDI/codebook/dtdhier.html]

Hierarchical Structure

of the Proposed Data Documentation DTD


The chart below outlines the groupings and elements within the proposed Document Type Definition for data codebooks.


Document
       |-- Header (Documentation Description)
       |
       |-- Study Description
       |
       |-- Data Files Description
       |
       |-- Record & Variable Description 
       |
       |-- Other Study-Related Materials (Encoder Defined)

Header (Documentation Description)
                Citation (of Documentation)
                   |
                   | -- Title (of Documentation) Statement
                   |                          |--Title
                   |                          |--Subtitle
                   |                          |--Common Title
                   |                          |--Parallel Title NEW
                   |                          |--Common Abrev.
                   |                          |--Producer Documentation 
                   |                          |       Number
                   |                          |--Archive Documentation
                   |                          |       Number
                   |
                   | -- Responsibility (for Documentation) Statement
                   |                          |--Principal Investigator
                   |                          |   /Author of Document
                   |                          |--PI Affiliation 
                   |                          |--Funding Agency
                   |                          |--Grant Number
                   |                          |--Other identifications/
                   |                                acknowledgments 
                   |
                   | -- Production (of Documentation) Statement
                   |                          |--Producer
                   |                          |--Date of Production
                   |                          |--Place of Production.
                   |                          |--Software used in 
                   |                                Document Production
                   | 
                   | -- Distributor (of Documentation) Statement
                   |                          |--Document Distributor
                   |                          |--Contact Persons
                   |                          |--Depositor
                   |                          |--Date of Deposit
                   |                          |--Date of Distribution
                   |
                   | -- Document Series Statement 
                   |                          |--Series Name
                   |                          |--Series Information
                   |
                   | -- Document Version Statement
                   |                          |--Version
                   |                          |--Version Responsibilty
                   |
                   | -- Bibliographic Citation of Documentation
                   |
                   

Study Level Description
                     | -- Citation (of Study)
                     | -- Study Information  
                     | -- Methodology and Processing (Study Level) 
                     | -- Data Access
                     | -- Other Study Description Materials (Encoder Defined)

Citation

                   | -- Title (of Study) Statement 
                   |                          |--Title
                   |                          |--Subtitle
                   |                          |--Common Title
                   |                          |--Parallel Title 
                   |                          |--Common Abrev.
                   |                          |--Producre Study Number
                   |                          |--Archive Study Number
                   |
                   | -- Responsibility (for Study) Statement 
                   |                          |--Principal Invest.
                   |                          |--PI Affiliation 
                   |                          |--Funding Agency
                   |                          |--Grant Number
                   |                          |--Collection Institution
                   |                          |--Data Collection Staff
                   |                          |--Research Initiator
                   |                          |--Other identifications
                   |                                /acknowledgments 
                   |
                   | -- Production (of Study) Statement
                   |                          |--Producer
                   |                          |--Date of Production
                   |                          |--Place of Production.
                   |                          |--Software used in 
                   |                               Data Produciton
                   |
                   | -- Distributor (of Study) Statement
                   |                          |--Data Distributor
                   |                          |--Contact Persons
                   |                          |--Depositor
                   |                          |--Date of Deposit
                   |                          |--Date of Distribution
                   |
                   | -- Study Series Statement 
                   |                          |--Series Name
                   |                          |--Series Information
                   |
                   | -- Version (of Study) Statement 
                   |                          |--Version
                   |                          |--Version Responsib.
                   |
                   | -- Bibliographic Citation of Study
                   |

Study Information

                   |
                   | -- Subject Information --|--Keywords
                   |                          |--Topic Classificat. 
                   |
                   | -- Abstract Information -|--Abstract ID Number
                   |                          |--Abstract
                   |                          |--Abstract Date
                   |
                   | -- Data Description -----|--Time Period Covered
                   |                          |--Date of Collection 
                   |                          |--Time Dimensions 
                   |                          |--Country
                   |                          |--Geographic Unit
                   |                          |--Unit of Analysis
                   |                          |--Universe
                   |                          |--Kind of Data
                   |
                   | -- Acknowledgements
                   |
                   | -- Documentation Statement
                   |                          |--Documentation
                   |                          |--Language(s) of Written 
                   |                          |      Materials 
                   |                          |--Codebook Information
                   |                          |--Related Materials
                   |                          |--Related Studies
                   |                          |--Other References Note 


Methodology and Processing (Study Level)
                   | -- Data Collection Methodology
                   |          |--Time Method
                   |          |--Frequency
                   |          |--Sampling Procedure
                   |          |--Major Deviations from Design
                   |          |--Mode of Data Collection
                   |          |--Type of Research Instrument
                   |          |--Sources Statement
                   |          |     |-Data Sources
                   |          |     |-Origins of Sources
                   |          |     |-Characteristics of Sources Noted
                   |          |     |-Documentation/Access to Sources
                   |          |--Characteristics of the Data
                   |          |--Collection Situation
                   |          |--Actions to Minimize Losses
                   |          |--Control Operations Performed by 
                   |          |          Original Investigator 
                   |          |--Control Operations Performed by Archive 
                   |          |--Cleaning Operations 
                   |          |--Weighting 
                   |     
                   | -- Error Notes (Study Level)
                   |     
                   | -- Analysis Information
                   |          |--Data Appraisal
                   |          |--Analysis Results
                   |          |--Potential Research Areas
                   |
                   | -- Study Status      

Data Access
                   | -- Data Set Availability
                   |         |--Original Archive Where Study Stored 
                   |          |--Collection Note 
                   |          |--Extent of Collection 
                   |          |--Completeness of Study Stored 
                   |          |--Number of Files 
                   |
                   | -- Data Use Statement 
                             |--Restrictions
                             |--Access Authority
                             |--Citation Requirement
                             |--Disclaimer
                             |--Analysis Conditions
                             |--Other Reanalysis Conditions Note 

Other Study Description Materials
  • Materials relating to the study description labeled and Identified by the DTD Users (encoders).
  • Encoders could follow the parent DTD encoding scheme (e.g. - TEI).

Data Files Description
                  |--File Description
                  |          |--File Name
                  |          |--Contents of File
                  |          |--File Structure
                  |          |         |--Structural Type
                  |          |         |--Key Variables
                  |          |         |--File Dimensions
                  |          |               |--Block Size
                  |          |               |--Records per Case
                  |          |               |--Overall Case Count
                  |          |               |--Overall Variable Count
                  |          |               |--Record
                  |          |                  |--LRECL
                  |          |                  |--Case Count
                  |          |                  |--Variable Count
                  |          |                  |--Constituent Variables
                  |          |                       (References to) 
                  |          |--Type of File
                  |          |--Place of Production
                  |          |--Extent of Process.
                  |          |--Missing Data
                  |          |--Software

Variable Description
                  |--Variable Groups 
                  |    |--Variable Group Label
                  |    |--Variable Group Text
                  |    |--Variable Group Definition
                  |
                  |--Variables
                     |--Location
                     |--Variable Label
                     |--Question
                     |      |--Pre-Question Text
                     |      |--Post-Question Text
                     |      |--Back Flow
                     |      |--Forward Progression
                     |--Range
                     |     (Atts: include/exclude,
                     |        +/-, GT, LT, LE, GE)
                     |--Universe
                     |--Summary Statistics
                     |--Variable Text
                     |--Category--|--Category Value
                     |            |--Category Label
                     |            |--Category Text
                     |            |--Category
                     |                 Statistic
                     |--Editing Instructions
                     |--Error Comments 
                          (Variable Level)

Other Study-Related Materials

Return to the: Data Documentation DTD Main Page
Prepared for the Data Documentation DTD committee
Comments to: John Brandt (John.Brandt@umich.edu)
Last updated: 1996/06/26.