The elements and their attributes described in this document are defined using version 2.0 of the DDI DTD.

Size: px

Start display at page:

Download "The elements and their attributes described in this document are defined using version 2.0 of the DDI DTD."

Thomasine Wilson
6 years ago
Views:

1 07/28/04 Modeling Virginia DDI Mapping Elements The following is a data dictionary of the minimum elements required in the Modeling Virginia Project. Minimum elements are marked with a. Those elements not marked are not required, but strongly recommended (if available). A DDI-xml template for UVa required and recommended elements is included. When creating the DDI put the elements in DDI-Section-Number order. This data dictionary is in the format: Name of Element DDI-Section-Number Element-Tag Definition of the Element The elements and their attributes described in this document are defined using version 2.0 of the DDI DTD. Describing the Metadata File Title of the DDI Metadata File titl This is the title of the dataset codebook. This title can be the same as the Dataset Title. Authoring Entity of the DDI Metadata File AuthEnty Person or agency responsible for the metadata file (or marked-up document). Producer of the DDI Metadata File producer The producer of the marked-up document is the person or organization with the administrative responsibility for the marked-up document. Copyright of the DDI Metadata File copyright Copyright statement for the marked-up document. Production date of the Metadata File proddate The date the DDI Metadata file was produced. Software used to create the DDI Metadata File software Software used to produce the marked-up document. The version attribute is used to specify the software version number. If using Nesstar, this will be created automatically. If not, do not use this element.

2 Holdings Information holdings Information concerning the electronic holdings of the Metadata File. The URI attribute is the URL to access the DDI Metadata file. FYI: There is a <holdings> element under <stdydscr> to point to the actual data file, if we wanted to use it. Describing the Dataset as a Whole Title titl Full title of the dataset. A full title should indicate the geographic scope of the data collection as well as the time period covered. ID Number IDNo Unique string or number (producer's or archive's number) for the data collection. Has agency attribute which could be used to specify where the ID originated. Authoring Entity AuthEnty The person, corporate body, or agency responsible for the data collection's substantive and intellectual content. Producer for Data Collection producer The producer of the data collection is the person or organization with the financial or administrative responsibility for the physical processes whereby the data collection was brought into existence. Use the role attribute to distinguish different stages of involvement in the production process, such as original producer. Producer is repeatable, within prodstmt. proddate is also repeatable. Need to figure out how to match dates with different Producers. Date of Production proddate Date the data collection was produced (not distributed or archived). Distributor of the data collection distrbtr The organization designated by the author or producer to generate copies of a particular data collection including any necessary editions or revisions. Contact Person for the Data Collection contact Names and addresses of individuals responsible for the data collection. 2

3 Depositor of the data collection depositr The name of the person (or institution) whom provided this data collection to the archive storing it. Date of Deposit depdate The date that the data collection was deposited with the archive that originally received it. Date of Distribution distdate The date that the data collection was released for distribution. Abstract abstract Summary describing the purpose, nature, and scope of the data collection, special characteristics of its contents, and major subject areas covered. Time Period Covered timeprd The time period to which the data refer. This item reflects the time period covered by the data. The attribute event should be used to specify start, end, or single. Geographic Coverage geogcover Information on the geographic coverage of the data. Include the total geographic scope of the data. Or Geographic Bounding Box geobndbox GeoBndBox is the minimum box, defined by west and east longitudes and north and south latitudes, that includes the largest geographic extent of the dataset's geographic coverage. Expressed in decimal degrees. In Version 2.0 of the DDI DTD. Restrictions restctn Any restrictions on access to or use of the collection such as privacy certification or distribution restrictions should be indicated here. These can be restrictions applied by the author, producer, or disseminator of the data collection. If the data are restricted to only a certain class of user, specify which type. 3

4 Physical Format of the Data File If there is more than one file per data collection, these elements are repeated for each physical file and the element <filename> must include the ID attribute. See the DDI template at the end. File Name filename Contains a short title that will be used to distinguish a particular file from other files in the data collection. Overall case count caseqnty Number of cases or observations in the entire file. Overall Variable Count varqnty Number of variables in the entire file. Total Number of Records recnumtot Overall record count in the file. Type of File filetype Types of data files include raw data (ASCII, EBCDIC, etc.) and software-dependent files such as SAS datasets, SPSS export files, etc. Format of the file Use only if filetype is ASCII or EBCDIC format Physical format of the data file: Logical record length format, card-image format (i.e., data with multiple records per case), delimited format, free format, comma-delimited etc. Place of File Production fileplac Indicates whether file was produced at an archive or produced elsewhere. This is an important element. I list it here because the DDI puts place of file production under File description and not the data set description section. Software software Software used to produce the data file. Use the attribute version to specify the version of the software. 4

5 Data File Notes 3.3 notes Additional information about the data file not covered in other elements. Variable Level Description If using Nesstar, most of this section will be created automatically. Variable Description 4.3 var This element describes all of the features of a single variable in a social science data file. The following attributes would be required: name contains the so-called "short label" for the variable. files is the ID identifying the file(s) (from the filenamer element) to which the variable belongs. measunit records the measurement unit, for example 'km','miles', etc. A variable will usually have a set of pre-defined values (numeric or character), OR a range of data values (numeric). If the variable has pre-defined values, use group (B) elements (under the element <catgry>). If the variable has a range of values, use group (A) elements (under the element <valrng>). Variable Label labl A descriptive phrase which defines the variable. Analysis Unit anlysunit Details whom or what the variable describes. (A) (A) (A) Variable Range range This is the actual range for the data values that are valid for this variable. min minimum value of the range max maximum value of the range UNITS specifies integer (INT) or real (REAL) numbers Variable Item item This is used if the values for the variable are single values and not a range of values. UNITS specifies integer (INT) or real (REAL) numbers VALUE value of the variable Range key key This element lists the category values and labels. 5

6 (A) Variable Notes notes Used to include additional information about the range of values for the variable. Undocumented Codes undoccod Values whose meaning is unknown. Variable Text txt An extended description, beyond that provided in Variable Name and Label, of the variable. Standard Categories stdcatgry Standard category group used in a variable, like industry codes, employment codes, or social class codes. The following attributes may be included: date version date of the category (i.e., SIC codes 1987 versus 1997) URI URL to the source documentation of the standard (B) (B) Category Value catvalu This contains the value of the variable. Category Label labl The definition of the variable. Variable Format (I am including this element because Nesstar DDI output includes it) varformat The technical format of the variable. type either character or numeric schema use other to be consistent with Nesstar Physical Description of the Variables in the File Variable location location Describes where the data element is located within the datafile. StartPos starting position of variable EndPos ending position of variable width number of columns the variable occupies 6

7 DDI Template The following symbols are used in the Template: * == ELEMENT IS OPTIONAL & REPEATABLE + == ELEMENT IS MANDATORY & REPEATABLE? == ELEMENT IS OPTIONAL & NON-REPEATABLE == ELEMENT IS MANDATORY & NON-REPEATABLE The above symbols are guides as you create your xml file so you will know what fields are repeatable and mandatory. They are to be deleted in the resultant xml file. Any optional element not used should be deleted as well as the DDI section number. <codebook> <docdscr> <citation>+ <titlestmt> <titl> title statement goes here </titl> </titlstmt> <rspstmt>? <AuthEnty>* Author for Metadata </AuthEnty> </rspstmt> <prodstmt>? <producer>* Producer for Metadata </producer> <copyright>? Copyright information goes here </copyright> <proddate>* date of Metadata production </proddate> <software version= 3.0 > Nesstar Publisher </software> </prodstmt> <holdings URI= URL for Metadata file > Marked up Codebook for title-from-titl </holdings> </docdscr> <stdydscr> <citation>+ <titlestmt> <titl> title statement goes here </titl> <IDNo agency= i.e. ICPSR >* Unique ID (producer s number) </IDNo> 7

8 <IDNo source= archive > UVA PID (auto generated) </IDNo> </titlstmt> <rspstmt>? <AuthEnty>* Authoring entity </AuthEnty> </rspstmt> <prodstmt>? <producer>* Producer for Data Collection </producer> <proddate>* date of production </proddate> </prodstmt> <diststmt>? <distrbtr>* distributor (organization) of data collection </distrbtr> <contact>* Contact person/address of data collection </contact> <depositr>* depositor of the data collection </depositr> <depdate>* Date of Deposit </depdate> <distdate>* Date of Distribution </distdate> </diststmt> </citation> <stdyinfo>* <abstract>* Summery of data collection </abstract> <sumdscr>* <timeprd event= single >* time period covered by data collection </timeprd> OR use 2 <timeprd> for time span: <timeprd event= start > time period collection started </timeprd> <timeprd event= end > time period collection ended </timeprd> <geogcover>* (or below) geographic coverage </geogcover> 8

9 if previous not used <geobndbox>? {in DDI version 2.0 only} <westbl>west Bounding Longitude</westBL> <eastbl>east Bounding Longitude</eastBL> <southbl>south Bounding Latitude</southBL> <northbl>north Bounding Latitude</northBL> </geobndbox> </sumdscr> </stdyinfo> <dataaccs>* <usestmt>* <restrctn>? restrictions on access or use of the data </restrctn> </usestmt> </dataaccs> </stdydscr> <filedscr>* <filetxt>? <filename ID= unique name-id >? file name of one of the data set(s) in the collection </filename> <dimensns>? <caseqnty>* number of cases or observations in the file </caseqnty> <varqnty>* number of variables in the file </varqnty> <recnumtot>* total number of records in the file </recnumtot> </dimensns> <filetype>? type of data file - ASCII, SAS, SPSS, etc. </filetype> <format>? physical format of the file: free, comma-delimit, etc.) </format> <fileplac> place of file production </fileplac> <software version= i.e. v3.0 >* software used to produce the file </software> </filetxt> <notes>* 3.3 Additional information about the data file </notes> </filedscr> 9

10 <datadscr>* REPEAT the <var> section for each variable, see the section Variable Level Description on when to use <valrng> (A) or <catgry> (B) 4.3 <var name= short-label files= unique file name-id measunit= units of measurement km >* <location StartPos= start position of data EndPos= end position of data width= number of cols of variable />* <labl>* descriptive phrase which ids the variable </labl> <anlysunit>* info on whom/what the variable describes </anlysunit> A-start A A A A A-end <valrng>* <range UNITS= INT or REAL min= minimum value max= max value />* <item UNITS== INT or REAL VALUE= variable value />* <key>? list of values and their labels </key> <notes>* additional information on variable values </notes> </valrng> <undoccod>* list of values whose meaning is unknown </undoccod> <txt>* extended description of variable names </txt> <stdcatgry date= if category values differ between versions URI= URL of the source >* standard category group used in defining variables </stdcatgry> B-start B B B-end <catgry>* <catvalu>? value of the variable </catvalu> <labl>* definition of the value </labl> </catgry> <varformat type= character-or-numeric schema= other />? </var> </datadscr> </codebook> 10

Mandatory and recommended fields

Making XML files for the new IDC of CESSDA: Mandatory and recommended fields Minutes from the CDG meeting at Essex, 5-6 September 2001 The Data Documentation Initiative and the development of new data