DDI Tag Library
This Tag Library describing the five main sections of the
Document Type Definition (DTD) for social science data
documentation developed by the Data Documentation Initiative (DDI)
Committee. These documents present English language
descriptions of XML (eXtensible Markup Language) DTD
elements and attributes and instructions
for their use as of Version 1 (Final) by Jerome McDonough, UC-Berkeley Library.
The following are the highest level components of any
document that will be marked up in compliance with this
DTD.
A graphical representation
of the document hierarchy is also available.
- Document Description
Items describing the marked-up document itself as well as its
source documents (citation, title, etc.)
Element -- optional, not repeatable.
- Study Description
Items describing the overall data collection (title, citation,
methodology, study scope, data access, etc.)
Element -- required, repeatable.
- Data Files Description
Items relating to the format, size, and structure
of the data files
Element -- optional, repeatable.
- Variables Description
Items relating to variables in the data collection
Element -- optional, repeatable.
- Other Study-Related Materials
Other study-related material not included in the
other sections (bibliography, separate questionnaire file, etc.)
Element -- optional, repeatable.
Document Description
(Codebook Header)
Document
|---DOCUMENT DESCRIPTION
|---Study Description
|---Data Files Description
|---Variables Description
|---Other Study-Related Materials
Role of the Document Description
The Document Description consists of bibliographic information
describing the DDI-compliant document itself as a whole. This Document
Description can be considered the wrapper or header whose elements
uniquely describe the full contents of the compliant DDI file. Since
the Document Description section is used to identify the DDI-compliant
file within an electronic resource discovery environment, this section
should be as complete as possible. The author in the Document
Description should be the individual(s) or organization(s) directly
responsible for the intellectual content of the DDI version, as
distinct from the person(s) or organization(s) responsible for the
intellectual content of the earlier paper or electronic edition from
which the DDI edition may have been derived. The producer in the
Document Description should be the agency or person that prepared the
marked-up document. Note that the Document
Description section contains a Documentation Source subsection (1.4)
consisting of information about the source of the DDI-compliant file--
that is, the hardcopy or electronic codebook that served as the source
for the marked-up codebook. These sections allow the creator of the
DDI file to produce version, responsibility, and other descriptions
relating to both the creation of that DDI file as a separate and
reformatted version of source materials (either
print or electronic) and the original source materials themselves.
To comply with the Dublin Core, it is recommended that the
following elements in the Document Description be used when the
appropriate information is available:
DUBLIN CORE DDI
------------------
Title 1.1.1.1 title (Title of Marked-up Document)
Creator 1.1.2.1 AuthEnty (Authoring Entity)
Publisher 1.1.3.1 producer (Producer)
[NOTE: The Dublin Core specifies that the
publisher should be "the entity
responsible for making the resource
available *in its present form*"
(emphasis added). For a DDI codebook
the publisher should be the entity
responsible for making the
*electronic* DDI version available.
Contributor 1.1.2.3 othId (Other Ident. & Acknowl.)
Date 1.1.3.3 prodDate (Date of Production)
[NOTE: The DC Date element
should refer to the date the
electronic resource (e.g., the DDI
version of the codebook) was created,
not any preceding paper version.]
Identifier Suggested DC Identifier: URL for DDI
Codebook, if applicable.
Alternatively, use the IDNo element
(1.1.1.5) within the Document Description
citation element.
Relation Partially maps to 1.4 docSrc (Documentation
Source). No mapping currently exists
for the relation type component.
Rights 1.1.3.2 copyright (Copyright)
Document Description
- <docDscr> 1.0
- Description: This section contains information about both the
document being created (the marked-up
document) and the source document (the electronic or print
codebook which is the source(s) of information),
if one exists. It addition, it provides information on how to use
the document contents and on the status of the
document itself. Although this element is optional, it is
strongly recommended that all marked-up documents
contain at minimum the following nested set of elements:
<docDscr> 1.0, <citation> 1.1, <titlStmt> 1.1.1,
and <titl> 1.1.1.1 (required).
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains Elements: Citation -- Marked-up Document,
Guide to Documentation,
Documentation Status,
Documentation Source,
Notes (Document Description)
- Citation -- Marked-up Document
- <citation> 1.1 (Generic element A.6)
- Description: Citation for the marked-up
document. This element encodes the bibliographic information
describing the marked-up codebook, including title information,
statement of responsibility, production and distribution information,
series and version information, text of a preferred bibliographic
citation, and notes (if any).
A MARCURI attribute is provided to link to the MARC
record for this citation.
Remarks: Note that it is the elements within this
citation element that are the primary source for most generic search
engines through their relationship to the Dublin Core tags.
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, MARCURI
- Contains Elements:
Title Statement -- Marked-up Document,
Responsibility Statement -- Marked-up Document,
Production Statement -- Marked-up Document,
Distributor Statement -- Marked-up Document,
Series Statement -- Marked-up Document,
Version Statement -- Marked-up Document,
Bibliographic Citation -- Marked-up Document,
Holdings Information -- Marked-up Document,
Notes (Citation) -- Marked-up Document
- Title Statement -- Marked-up Document
- <titlStmt> 1.1.1 (Generic element A.6.1)
- Description: Title statement for the
marked-up document.
- Required
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains Elements:
Title -- Marked-up Document,
Subtitle -- Marked-up Document,
Alternative Title -- Marked-up Document,
Parallel Title -- Marked-up Document,
ID Number -- Marked-up Document
- Title -- Marked-up Document
- <titl> 1.1.1.1 (Generic element A.6.1.1)
- Description: Contains the full authoritative title of the
marked-up codebook. The marked-up codebook title will in most cases be
identical to the title for the data collection (2.1.1). A full title
should indicate the geographic scope of the data collection as well as
the time period covered. Equivalent to Dublin Core Title.
- Examples:
<titl>Domestic Violence Experience in Omaha, Nebraska,
1986-1987</titl>
<titl>Census of Population, 1950 [United States]: Public Use
Microdata Sample</titl>
<titl>Monitoring the Future: A Continuing Study of American
Youth, 1995</titl>
- Required
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Subtitle -- Marked-up Document
- <subTitl> 1.1.1.2 (Generic element A.6.1.2)
- Description: A subtitle is a
secondary title used to amplify or state certain limitations of the
main title. It may repeat information already in the main title.
- Examples:
<titl>Monitoring the Future: A Continuing Study of American
Youth, 1995</titl>
<subTitl>A Continuing Study of American Youth, 1995</subTitl>
<titl>Census of Population, 1950 [United States]: Public Use
Microdata Sample</titl> <subTitl>Public Use
Microdata Sample</subTitl>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Alternative Title -- Marked-up Document
- <altTitl> 1.1.1.3 (Generic element A.6.1.3)
- Description: The alternative title may be the title by which a data collection is commonly referred to or it may be an abbreviation for the title.
- Examples:
<titl>Census of Population, 1950 [United States]: Public Use
Microdata Sample</titl>
<altTitl>PUMS</altTitl>
<titl>Equality of Educational Opportunity (Coleman) Study
(EEOS), 1996</titl>
<altTitl>The Coleman Study</altTitl>
<altTitl>EEOS</altTitl>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Parallel Title -- Marked-up Document
- <parTitl> 1.1.1.4 (Generic element A.6.1.4)
- Description: Title translated into another language.
- Example:
<titl>Politbarometer West [Germany], Partial
Accumulation, 1977-1995</titl>
<parTitl>Politbarometer, 1977-1995: Partielle Kumulation</parTitl>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- ID Number -- Marked-up Document
- <IDNo> 1.1.1.5 (Generic element A.6.1.5)
- Description: Unique string or number
(producer's or archive's number) for the marked-up
document. An "agency" attribute is supplied. Equivalent to Dublin Core Identifier.
- Examples:
<IDNo agency='ICPSR'>6678</IDNo>
<IDNo agency='ZA'>2010</IDNo>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, agency
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Responsibility Statement -- Marked-up
Document
- <rspStmt> 1.1.2 (Generic Element A.6.2)
- Description: Responsibility for the
creation of the marked-up codebook.
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains Elements:
Authoring Entity / Primary Investigator -- Marked-up Document,
Other Identifications / Acknowledgments -- Marked-up Document
- Authoring Entity / Primary Investigator -- Marked-up Document
- <AuthEnty> 1.1.2.1 (Generic element A.6.2.1)
- Description: The person, corporate
body, or agency responsible for the marked-up document's substantive
and intellectual content. Usually the same as the authoring entity
responsible for the data collection (2.1.2.1). Repeat the element for each
author, and use the affiliation attribute if available. Invert first and
last name and use commas. Equivalent to Dublin Core Creator.
Remarks: The author in the Document
Description should be the individual(s) or organization(s) directly
responsible for the intellectual content of the DDI version, as
distinct from the person(s) or organization(s) responsible for the
intellectual content of the earlier paper or electronic edition from
which the DDI edition may have been derived. The producer (1.1.3.1) in the
Document Description should be the agency or person that prepared the
marked-up document.
- Examples:
<AuthEnty>United States Department of Commerce. Bureau of the Census</AuthEnty>
<AuthEnty affiliation='European Commission'>Rabier, Jacques-Rene</AuthEnty>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, affiliation
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Other Identifications / Acknowledgments -- Marked-up Document
- <othId> 1.1.2.2 (Generic element A.6.2.2)
- Description: Statements of
responsibility not recorded in the title and statement of
responsibility areas. Indicate here the persons or bodies connected
with the work, or significant persons or bodies connected with
previous editions and not already named in the description. For
example, the name of the person who edited the marked-up documentation might
be cited here, using the role and affiliation attributes.
Remarks: The paragraph tag <p> must be used in this element.
- Example:
<othId role='editor' affiliation='INRA'><p>Jane Smith</p></othId>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, type, role, affiliation
- Contains: <p>, othId
- Production Statement -- Marked-up Document
- <prodStmt> 1.1.3 (Generic element A.6.3)
- Description: Production statement for the marked-up document.
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains Elements:
Producer -- Marked-up Document,
Copyright -- Marked-up Document,
Date of Production -- Marked-up Document,
Place of Production -- Marked-up Document,
Software Used in Production -- Marked-up Document,
Funding Agency -- Marked-up Document,
Grant Number -- Marked-up Document
- Producer -- Marked-up Document
- <producer> 1.1.3.1 (Generic element A.6.3.1)
- Description: The producer of the marked-up
document is the person or organization with the financial or
administrative responsibility for the physical processes whereby the
marked-up document was brought into existence. Use the role attribute
to distinguish different stages of involvement in the production
process, such as original producer. Equivalent to Dublin Core
Publisher.
- Example:
<producer abbr='ICPSR' affiliation='Institute for Social Research'>Inter-university Consortium for Political and Social Research</producer>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, abbr, affiliation, role
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Copyright -- Marked-up Document
- <copyright> 1.1.3.2 (Generic element A.6.3.2)
- Description: Copyright statement for
the marked-up document. Equivalent to Dublin Core Rights.
- Example:
<copyright>Copyright(c) ICPSR, 2000</copyright>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Date of Production -- Marked-up Document
- <prodDate> 1.1.3.3 (Generic element A.6.3.3)
- Description: Date the marked-up
document was produced (not distributed or archived).
The ISO
standard for dates (YYYY-MM-DD) is recommended for use with the date
attribute. Equivalent to Dublin Core Date.
- Example:
<prodDate date='1999-01-25'>January 25, 1999</prodDate>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, date
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Place of Production -- Marked-up Document
- <prodPlac> 1.1.3.4 (Generic element A.6.3.4)
- Description: Address of the archive
or agency that produced the marked-up document.
- Example:
<prodPlac>Ann Arbor, MI: Inter-university Consortium for Political and Social Research</prodPlac>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Software Used in Production -- Marked-up Document
- <software> 1.1.3.5 (Generic element A.6.3.5)
- Description: Software used to produce
the marked-up document. A "version" attribute permits specification of the software
version number. The "date" attribute is provided to enable specification
of the date (if any) for the software release. The ISO
standard for dates (YYYY-MM-DD) is recommended for use with the date
attribute.
- Examples:
<software version='1.0'>MRDC Codebook Authoring Tool</software>
<software version='8.0'>Arbortext Adept Editor</software>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, version, date
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Funding Agency -- Marked-up Document
- <fundAg> 1.1.3.6 (Generic element A.6.3.6)
- Description: The source(s) of funds
for production of the marked-up document. If different funding
agencies sponsored different stages of the production process, use the
role attribute to distinguish them.
- Examples:
<fundAg abbr='NSF' role="infrastructure">National Science Foundation</fundAg>
<fundAg abbr='SUN' role="equipment">Sun Microsystems</fundAg>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, abbr, role
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Grant Number -- Marked-up Document
- <grantNo> 1.1.3.7 (Generic element A.6.3.7)
- Description: The grant/contract
number of the project that sponsored the markup effort. If more
than one, indicate the appropriate agency using the "agency"
attribute. If different funding
agencies sponsored different stages of the production process, use the
role attribute to distinguish the grant numbers.
- Example:
<grantNo agency='Bureau of Justice Statistics'>J-LEAA-018-77</grantNo>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, agency, role
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Distributor Statement -- Marked-up Document
- <distStmt> 1.1.4 (Generic element A.6.4)
- Description: Distribution statement for the marked-up document.
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains Elements:
Distributor -- Marked-up Document,
Contact Person -- Marked-up Document,
Depositor -- Marked-up Document,
Date of Deposit -- Marked-up Document,
Date of Distribution -- Marked-up Document
- Distributor -- Marked-up Document
- <distrbtr> 1.1.4.1 (Generic element A.6.4.1)
- Description: The organization
designated by the author or producer to generate copies of particular
marked-up documentation including any necessary editions or
revisions. Names and addresses
may be specified and other archives may be co-distributors. A URI
attribute is included to provide an URN or URL to the ordering service
or download facility on a website.
- Example:
<distrbtr abbr='ICPSR' affiliation='Institute for
Social Research' URI='http://www.icpsr.umich.edu'>Ann Arbor, MI: Inter-university Consortium for
Politcal and Social Research</distrbtr>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, abbr, affiliation, URI
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Contact Person -- Marked-up Document
- <contact> 1.1.4.2 (Generic element A.6.4.2)
- Description: Names and addresses of
individuals responsible for the marked-up document. Individuals listed
as contact persons will be used as resource persons regarding problems
or questions raised by the user community. The URI attribute should be
used to indicate a URN or URL for the homepage of the contact
individual. The email attribute is used to indicate an email address
for the contact individual.
- Example:
<contact affiliation='University of Wisconsin' email='jsmith@...>Jane Smith</contact>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, affiliation, URI, email
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Depositor -- Marked-up Document
- <depositr> 1.1.4.3 (Generic element A.6.4.3)
- Description: The name of the person
(or institution) who provided this marked-up documentation to the
archive storing it.
- Example:
<depositr abbr='BJS' affiliation='U.S. Department of Justice'>Bureau of Justice Statistics</depositr>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, abbr, affiliation
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Date of Deposit -- Marked-up Document
- <depDate> 1.1.4.4 (Generic element A.6.4.4)
- Description: The date that the
marked-up document was deposited with the archive that originally
received it. The ISO
standard for dates (YYYY-MM-DD) is recommended for use with the date
attribute.
- Example:
<depDate date='1999-01-25'>January 25, 1999</depDate>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, date
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Date of Distribution -- Marked-up Document
- <distDate> 1.1.4.5 (Generic element A.6.4.5)
- Description: Date that the marked-up
document was made available for distribution/presentation. The ISO
standard for dates (YYYY-MM-DD) is recommended for use with the date
attribute.
- Example:
<distDate date='1999-01-25'>January 25, 1999</distDate>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, date
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Series Statement -- Marked-up Document
- <serStmt> 1.1.5 (Generic element A.6.5)
- Description: Series statement for the
marked-up document. The URI attribute is provided to point to a central
Internet repository of series information.
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, URI
- Contains Elements:
Series Name -- Marked-up Document,
Series Information -- Marked-up Document
- Series Name -- Marked-up Document
- <serName> 1.1.5.1 (Generic element A.6.5.1)
- Description: The name of the series
to which the marked-up document belongs. This will probably be the same as
the Series Name for the study or data collection (2.1.5.1).
- Example:
<serName abbr='CPS'>Current Population Survey Series</serName>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, abbr
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Series Information -- Marked-up Document
- <serInfo> 1.1.5.2 (Generic element A.6.5.2)
- Description: Contains a history of
the series and a summary of those features that apply to the series as
a whole. This will
probably be the same as the Series Information for the study or data
collection (2.1.5.2).
- Example:
<serInfo>The Current Population Survey (CPS)
is a household sample survey conducted monthly by the Census Bureau to
provide estimates of employment, unemployment, and other characteristics
of the general labor force, estimates of the population as a whole,
and estimates of various subgroups in the population. The entire
non-institutionalized population of the United States is sampled to
obtain the respondents for this survey series.</serInfo>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Version Statement -- Marked-up Document
- <verStmt> 1.1.6 (Generic element A.6.6)
- Description: Version statement for the marked-up document.
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains Elements:
Version -- Marked-up Document,
Version Responsibility Statement -- Marked-up Document,
Notes (Version) -- Marked-up Document
- Version -- Marked-up Document
- <version> 1.1.6.1 (Generic element A.6.6.1)
- Description: Also known as release or
edition. If there have been substantive changes in the marked-up
document since its creation, this statement should be used. The ISO
standard for dates (YYYY-MM-DD) is recommended for use with the date
attribute.
Remarks: ICPSR distinguishes among the terms "release," "version," and
"edition" in the following ways:
- ICPSR Edition: Used only
for intensively processed collections, for which ICPSR has produced a
unique edition of the data. This usually involves checking for
undocumented codes and consistency checks. Signals that additional
intellectual effort has gone into producing the collection.
- ICPSR Version: Used to indicate that
ICPSR has revised the format of a collection or added components
to it, in most cases without
changing any data values. A study is considered an "ICPSR version"
if one or more of these steps has been performed:
(1) Converting software-specific system files or export/transport
files to raw data;
(2) Generating SAS and/or SPSS data definition statements;
(3) Reformatting files, e.g., removing blanks to use space more
efficiently;
(4)Scanning hardcopy documentation; or
(5)Reformatting machine-readable documentation, e.g., converting
text created in a word-processing package to ASCII text.
- Release: Used for data collections that are
being disseminated exactly as they came from the data depositor
(except for the addition of an ICPSR cover and ICPSR front matter).
- Example:
<version type='edition' date='1999-01-25'>Second ICPSR Edition</version>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, type (release, version, edition), date
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Version Responsibility Statement -- Marked-up Document
- <verResp> 1.1.6.2 (Generic element A.6.6.2)
- Description: Used to indicate the
organization or person responsible for the version of the marked-up
document.
- Example:
<verResp>Zentralarchiv fuer Empirische Sozialforschung</verResp>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, affiliation
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Notes (Version) -- Marked-up Document
- <notes> 1.1.6.3 (Generic element A.4)
- Description: Used to indicate
additional information regarding the version or the version
responsibility statement for the marked-up document, in particular to indicate what makes a new
version different from its predecessor. "Notes" sections appear in
several places in the DTD. The attributes for notes permit a
controlled vocabulary to be developed (type and subject), the level of
the DTD to which the note refers to be identified (study, file,
variable, etc.), and the author of the note to be indicated
(resp).
- Example:
<notes resp='Jane Smith'>Additional information on derived variables
has been added to this marked-up version of the documentation.</notes>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, type, subject level, resp
- Contains: #PCDATA, Link to other
element(s) within the codebook, reference to a table.
- Bibliographic Citation -- Marked-up Document
- <biblCit> 1.1.7 (Generic element A.6.7)
- Description: Complete bibliographic
reference containing all of the standard elements of a citation that
can be used to cite the marked-up document. The "format" attribute is
provided to enable specification of the particular citation style
used, e.g. APA, MLA, Chicago, etc.
- Example:
<biblCit format='MRDF'>Rabier, Jacques-Rene, and Ronald
Inglehart. EURO-BAROMETER 11: YEAR OF THE CHILD IN EUROPE, APRIL 1979
[Codebook file]. Conducted by Institut Francais D'Opinion Publique
(IFOP), Paris, et al. ICPSR ed. Ann Arbor, MI: Inter-university
Consortium for Political and Social Resarch [producer and
distributor], 1981. </biblCit>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, format
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Holdings Information -- Marked-up Document
- <holdings> 1.1.8 ((Generic element A.6.8)
- Description: Information concerning
either the physical or electronic holdings of the cited work. Attributes
include: location--The physical location where a copy is held;
callno--The call number for a work at the location specified; and
URI--A URN or URL for accessing the electronic copy of the cited
work.
- Example:
<holdings location='ICPSR DDI Repository' callno='inap.'
URI='http://www.icpsr.umich.edu/DDIrepository/'>
Marked-up Codebook for Current Population Survey, 1999: Annual Demographic
File</holdings>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, location, callno, URI
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Notes (Citation) -- Marked-up Document
- <notes> 1.1.9 (Generic element A.4)
- Description: Used to indicate
additional information regarding the citation for the marked-up
document. "Notes" sections appear
in several places in the DTD. The attributes for notes permit a
controlled vocabulary to be developed (type and subject), the level of
the DTD to which the note refers to be identified (study, file,
variable, etc.), and the author of the note to be indicated
(resp).
- Example:
<notes resp='Jane Smith'>This citation was
prepared by the archive based on information received from the markup
authors.</notes>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, type, subject level, resp
- Contains: #PCDATA, Link to other
element(s) within the codebook, reference to a table.
- Guide to the Documentation -- Marked-up Document
- <guide> 1.2
- Description: List of terms and definitions used in the document. Provided to assist users in using the document correctly. For further examples, see the Codebook Information section of any of the printed, bound codebooks distributed by ICPSR.
- Example:
<guide>Metro Area OR Twin Cities =
Minneapolis/St. Paul MSA; Greater MN = All Minnesota Counties not
included in the Minneapolis/St. Paul MSA; The Range = Upper Northeast
quadrant of Minnesota traditionally associated with iron ore and
taconite mining.</guide>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Documentation Status -- Marked-up Document
- <docStatus> 1.3
- Description: Use this field to
indicate if the document is being presented/distributed before it has
been finalized. Some data producers and social science data archives
employ data processing strategies that provide for release of data and
documentation at various stages of processing.
- Example:
<docStatus>This marked-up document includes a provisional data
dictionary and brief citation only for the purpose of providing basic
access to the data file. A complete codebook will be published at a
later date.</docStatus>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Documentation Source
- <docSrc> 1.4 (Generic element A.6)
- Description: Citation for the source
document. This element encodes the bibliographic information
describing the source codebook, including title information, statement
of responsibility, production and distribution information, series and
version information, text of a preferred bibliographic citation, and
notes (if any). Information for this section should be taken directly
from the source document whenever possible. If additional information
is obtained and entered in the elements within this section, the
source of this information should be noted in the source attribute of
the particular element tag.
A MARCURI attribute is provided to link to the MARC
record for this citation.
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, MARCURI
- Contains Elements:
Title Statement -- Source Document,
Responsibility Statement -- Source Document,
Production Statement -- Source Document,
Distributor Statement -- Source Document,
Series Statement -- Source Document,
Version Statement -- Source Document,
Bibliographic Citation -- Source Document,
Holdings Information -- Source Document,
Notes (Version) -- Source Document
- Title Statement -- Source Document
- <titlStmt> 1.4.1 (Generic element A.6.1)
- Description: Title statement for the
source document.
- Required
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains Elements:
Title -- Source Document,
Subtitle -- Source Document,
Alternative Title -- Source Document,
Parallel Title -- Source Document,
ID Number -- Source Document
- Title -- Source Document
- <titl> 1.4.1.1 (Generic element A.6.1.1)
- Description: Contains the full authoritative title of the
source document. The source document title will in many cases be
identical to the title for the marked-up document. If the source
document contains no title, the title provided in this element should
indicate the geographic scope of the data collection as well as the
time period covered.
- Examples:
<titl>Domestic Violence Experience in Omaha, Nebraska, 1986-1987</titl>
<titl>Census of Population, 1950 [United States]: Public Use
Microdata Sample</titl>
<titl>Monitoring the Future: A Continuing Study of American Youth, 1995</titl>
- Required
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Subtitle -- Source Document
- <subTitl> 1.4.1.2 (Generic element A.6.1.2)
- Description: A subtitle is a secondary title used to amplify or state certain limitations of the main title. It may repeat information already in the main title.
- Examples:
<titl>Monitoring the Future: A Continuing Study of American Youth, 1995</titl>
<subTitl>A Continuing Study of American Youth, 1995</subTitl>
<titl>Census of Population, 1950 [United States]: Public Use
Microdata Sample</titl>
<subTitl>Public Use Microdata Sample</subTitl>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Alternative Title -- Source Document
- <altTitl> 1.4.1.3 (Generic element A.6.1.3)
- Description: The alternative title
may be the title by which a data collection is commonly referred to or
it may be an abbreviation for the title.
- Examples:
<titl>Census of Population, 1950 [United States]: Public Use
Microdata Sample</titl>
<altTitl>PUMS</altTitl>
<titl>Equality of Educational Opportunity (Coleman) Study
(EEOS), 1996</titl>
<altTitl>The Coleman Study</altTitl>
<altTitl>EEOS</altTitl>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Parallel Title -- Source Document
- <parTitl> 1.4.1.4 (Generic element A.6.1.4)
- Description: Title translated into another language.
- Example:
<titl>Politbarometer West [Germany], Partial
Accumulation, 1977-1995</titl>
<parTitl>Politbarometer, 1977-1995: Partielle Kumulation</parTitl>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- ID Number -- Source Document
- <IDNo> 1.4.1.5 (Generic element A.6.1.5)
- Description: Unique string or number
(producer's or archive's number) for the source document. An "agency"
attribute is supplied.
- Examples:
<IDNo agency='ICPSR'>6678</IDNo>
<IDNo agency='ZA'>2010</IDNo>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, agency
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Responsibility Statement -- Source Document
- <rspStmt> 1.4.2 (Generic element A.6.2)
- Description: Responsibility for the creation of the source document.
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains Elements:
Authoring Entity / Primary Investigator -- Source Document,
Other Identifications / Acknowledgments -- Source Document,
- Authoring Entity / Primary Investigator -- Source Document
- <AuthEnty> 1.4.2.1 (Generic element A.6.2.1)
- Description: The person, corporate
body, or agency responsible for the source document's substantive and
intellectual content. Usually the same as the authoring entity
responsible for the data collection (2.1.2.1). Repeat the element for each
author, and use the affiliation attribute if available. Invert first and
last name and use commas.
Remarks: The author in this element
should be the individual(s) or organization(s) directly
responsible for the intellectual content of the source document, as
distinct from the person(s) or organization(s) responsible for the
intellectual content of the marked-up document.
- Examples:
<AuthEnty>United States Department of Commerce. Bureau of the Census</AuthEnty>
<AuthEnty affiliation='European Commission'>Rabier, Jacques-Rene</AuthEnty>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, affiliation
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Other Identifications / Acknowledgments -- Source Document
- <othId> 1.4.2.2 (Generic element A.6.2.2)
- Description: Statements of
responsibility not recorded in the title and statement of
responsibility areas. Indicate here the persons or bodies connected
with the work, or significant persons or bodies connected with
previous editions and not already named in the description. For
example, the name of the person who edited the source document might
be cited here, using the role and affiliation attributes.
Remarks: The paragraph tag <p> must be used in this element.
- Example:
<othId role='editor' affiliation='INRA'><p>Jane Smith</p></othId>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, type, role, affiliation
- Contains: <p>, othId
- Production Statement -- Source Document
- <prodStmt> 1.4.3 (Generic element A.6.3)
- Description: Production statement for
the source document.
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains Elements:
Producer -- Source Document,
Copyright -- Source Document,
Date of Production -- Source Document,
Place of Production -- Source Document,
Software Used in Production -- Source Document,
Funding Agency -- Source Document,
Grant Number -- Source Document
- Producer -- Source Document
- <producer> 1.4.3.1 (Generic element A.6.3.1)
- Description: The producer of the
source document is the person or organization with the financial or
administrative responsibility for the physical processes whereby the
source document was brought into existence. Use the role attribute to
distinguish different stages of involvement in the production process,
such as original producer.
- Example:
<producer abbr='MNPoll' affiliation='Minneapolis Star
Tibune Newspaper' role = 'original producer'>Star Tribune Minnesota
Poll</producer> <producer abbr='MRDC' affiliation='University
of Minnesota' role = 'final production'>Machine Readable Data
Center</producer>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, abbr, affiliation, role
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Copyright -- Source Document
- <copyright> 1.4.3.2 (Generic element A.6.3.2)
- Description: Copyright statement for the source document.
- Example:
<copyright>Copyright(c) ICPSR, 2000</copyright>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Date of Production -- Source Document
- <prodDate> 1.4.3.3 (Generic element A.6.3.3)
- Description: Date the source document
was produced (not distributed or archived). The ISO standard for dates
(YYYY-MM-DD) is recommended for use with the date attribute.
- Example:
<prodDate date='1999-01-25'>January 25, 1999</prodDate>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, date
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Place of Production -- Source Document
- <prodPlac> 1.4.3.4 (Generic element A.6.3.4)
- Description: Address of the archive
or agency that produced the source document.
- Example:
<prodPlac>Ann Arbor, MI: Inter-university Consortium for Political and Social Research</prodPlac>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Software Used in Production -- Source Document
- <software> 1.4.3.5 (Generic element A.6.3.5)
- Description: Identifies the software
used in creating or storing the source document. A "version" attribute
permits specification of the software version number. The "date"
attribute is provided to enable specification of the date (if any) for
the software release. The ISO standard for dates (YYYY-MM-DD) is
recommended for use with the date attribute.
- Example:
<software version='4.0'>PageMaker</software>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, version, date
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Funding Agency -- Source Document
- <fundAg> 1.4.3.6 (Generic element A.6.3.6)
- Description: The source(s) of funds
for production of the source document. If different funding agencies
sponsored different stages of the production process, use the role
attribute to distinguish them.
- Example:
<fundAg abbr='NSF'>National Science Foundation</fundAg>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, abbr, role
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Grant Number -- Source Document
- <grantNo> 1.4.3.7 (Generic element A.6.3.7)
- Description: The grant/contract
number of the project that sponsored the documentation effort. If more
than one, indicate the appropriate agency using the "agency"
attribute. If different funding agencies
sponsored different stages of the production process, use the role
attribute to distinguish the grant numbers.
- Example:
<grantNo agency='Bureau of Justice Statistics'>J-LEAA-018-77</grantNo>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, agency, role
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Distributor Statement -- Source Document
- <distStmt> 1.4.4 (Generic element A.6.4)
- Description: Distribution statement for the source document.
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains Elements:
Distributor -- Source Document,
Contact Person -- Source Document,
Depositor -- Source Document,
Date of Deposit -- Source Document,
Date of Distribution -- Source Document
- Distributor -- Source Document
- <distrbtr> 1.4.4.1 (Generic element A.6.4.1)
- Description: The organization
designated by the author or producer to generate copies of a
particular source document including any necessary editions or
revisions. Distributor of the source document. Names and addresses may
be specified, and other archives may be co-distributors. A URI
attribute is included to provide an URN or URL to the ordering service
or download facility on a website.
- Example:
<distrbtr abbr='ICPSR" affiliation='Institute for
Social Research' URI='http://www.icpsr.umich.edu'>Ann Arbor, MI: Inter-university Consortium for
Political and Social Research</distrbtr>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, abbr, affiliation, URI
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Contact Person -- Source Document
- <contact> 1.4.4.2 (Generic element A.6.4.2)
- Description: Names and addresses of
individuals responsible for the source document. May be
PIs. Individuals listed as contact persons will be used as resource
persons regarding problems or questions raised by the user
community. The URI attribute should be used to indicate a URN or URL
for the homepage of the contact individual. The email attribute is
used to indicate an email address for the contact individual.
- Example:
<contact affiliation='University of Wisconsin' email='jsmith@uwisc.edu'>Jane Smith</contact>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, affiliation, URI, email
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Depositor -- Source Document
- <depositr> 1.4.4.3 (Generic element A.6.4.3)
- Description: The name of the person (or institution) who provided this source document to the archive storing it.
- Example:
<depositr abbr='BJS' affiliation='U.S. Department of Justice'>Bureau of Justice Statistics</depositr>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, abbr, affiliation
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Date of Deposit -- Source Document
- <depDate> 1.4.4.4 (Generic element A.6.4.4)
- Description: The date that the source
document was deposited with the archive that originally received
it. The ISO standard for dates (YYYY-MM-DD) is recommended for use
with the date attribute.
- Example:
<depDate date='1999-01-25'>January 25, 1999</depDate>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, date
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Date of Distribution -- Source Document
- <distDate> 1.4.4.5 (Generic element A.6.4.5)
- Description: The date
that the source document was released for distribution. The ISO
standard for dates (YYYY-MM-DD) is recommended for use
with the date attribute.
- Example:
<distDate date='1999-01-25'>January 25, 1999</distDate>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, date
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Series Statement -- Source Document
- <serStmt> 1.4.5 (Generic element A.6.5)
- Description: Series statement for the
source document. The URI attribute is provided to point to a central
Internet repository of series information.
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, URI
- Contains Elements:
Series Name -- Source Document,
Series Information -- Source Document
- Series Name -- Source Document
- <serName> 1.4.5.1 (Generic element A.6.5.1)
- Description: The name of the data
series to which the source document belongs. This will probably be the same as
the Series Name for the study or data collection (2.1.5.1).
- Example:
<serName abbr='CPS'>Current Population Survey Series</serName>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, abbr
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Series Information -- Source Document
- <serInfo> 1.4.5.2 (Generic element A.6.5.2)
- Description: Contains a history of
the data series and a summary of those features that apply to the
series as a whole. This will
probably be the same as the Series Information for the study or data
collection (2.1.5.2).
- Example:
<serInfo>The Current Population Survey (CPS)
is a household sample survey conducted monthly by the Census Bureau to
provide estimates of employment, unemployment, and other charcteristics
of the general labor force, estimates of the population as a whole,
and estimates of various subgroups in the population. The entire
non-institutionalized population of the United States is sampled to
obtain the respondents for this survey series.</serInfo>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Version Statement -- Source Document
- <verStmt> 1.4.6 (Generic element A.6.6)
- Description: Version statement for
the source document.
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains Elements:
Version -- Source Document,
Version Responsibility Statement -- Source Document,
Notes (Version) -- Source Document
- Version -- Source Document
- <version> 1.4.6.1 (Generic element A.6.6.1)
- Description: Also known as release or
edition. If there have been substantive changes in the source document
since its creation, this statement should be used. The ISO standard
for dates (YYYY-MM-DD) is recommended for use with the date
attribute.
Remarks: ICPSR distinguishes among the terms "release," "version," and
"edition" in the following ways:
- ICPSR Edition: Used only
for intensively processed collections, for which ICPSR has produced a
unique edition of the data. This usually involves checking for
undocumented codes and consistency checks. Signals that additional
intellectual effort has gone into producing the collection.
- ICPSR Version: Used to indicate that
ICPSR has revised the format of a collection or added components
to it, in most cases without
changing any data values. A study is considered an "ICPSR version"
if one or more of these steps has been performed:
(1) Converting software-specific system files or export/transport
files to raw data;
(2) Generating SAS and/or SPSS data definition statements;
(3) Reformatting files, e.g., removing blanks to use space more
efficiently;
(4)Scanning hardcopy documentation; or
(5)Reformatting machine-readable documentation, e.g., converting
text created in a word-processing package to ASCII text.
- Release: Used for data collections that are
being disseminated exactly as they came from the data depositor
(except for the addition of an ICPSR cover and ICPSR front matter).
- Example:
<version type='edition' date='1999-01-25'>Second ICPSR Edition</version>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, type (release, version, edition), date
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Version Responsibility Statement -- Source Document
- <verResp> 1.4.6.2 (Generic element A.6.6.2)
- Description: Used to indicate the
organization or person responsible for the version of the source
document.
- Example:
<verResp>Zentralarchiv fuer Empirische Sozialforschung</verResp>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, affiliation
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Notes (Version) -- Source Document
- <notes> 1.4.6.3 (Generic element A.4)
- Description: Used to indicate additional information regarding the version or the version responsibility statement, in particular to indicate what makes a new version different from its predecessor. "Notes" sections appear in several places in the DTD. The attributes for notes permit a controlled vocabulary to be developed (type and subject), the level of the DTD to which the note refers to be identified (study, file, variable, etc.), and the author of the note to be indicated (resp).
- Example:
<notes resp='Jane Smith'>The source codebook was produced from
original hardcopy materials using
Optical Character Recognition (OCR).</notes>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, type, subject level, resp
- Contains: #PCDATA, Link to other
element(s) within the codebook, reference to a table.
- Bibliographic Citation -- Source Document
- <biblCit> 1.4.7 (Generic element A.6.7)
- Description: Complete bibliographic reference containing all of the standard elements of a citation that can be used to cite the source document. The "format" attribute is provided to enable specification of the particular citation style used, e.g. APA, MLA, Chicago, etc.
- Example:
<biblCit format='MRDF'>Rabier, Jacques-Rene, and Ronald
Inglehart. EURO-BAROMETER 11: YEAR OF THE CHILD IN EUROPE, APRIL 1979
[Computer file]. Conducted by Institut Francais D'Opinion Publique
(IFOP), Paris, et al. ICPSR ed. Ann Arbor, MI: Inter-university
Consortium for Political and Social Research [producer and
distributor], 1981. </biblCit>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, format
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Holdings Information -- Source Document
- <holdings> 1.4.8 (Generic element A.6.8)
- Description: Information concerning
either the physical or electronic holdings of the cited work. Attributes
include: location--The physical location where a copy is held;
callno--The call number for a work at the location specified; and
URI--A URN or URL for accessing the electronic copy of the cited
work.
- Example:
<holdings location='University of Michigan Graduate Library' callno='inap.'
URI='http://www.umich.edu/library/'>
Codebook for Current Population Survey, 1999: Annual Demographic File
</holdings>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, format, location, callno, URI
- Contains: #PCDATA, Link to other
element(s) within the codebook.
- Notes -- Source Document
- <notes> 1.4.9 (Generic element A.4)
- Description: Used to indicate
additional information about the source document. "Notes"
sections appear in several places in the DTD. The attributes for notes
permit a controlled vocabulary to be developed (type and subject), the
level of the DTD to which the note refers to be identified (study,
file, variable, etc.), and the author of the note to be indicated
(resp).
- Example:
<notes resp='Jane Smith'>A machine-readable version of the source
codebook was supplied by the Zentralarchiv.</notes>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, type, subject level, resp
- Contains: #PCDATA, Link to other
element(s) within the codebook, reference to a table.
- Notes -- Document Description
- <notes> 1.5 (Generic element A.4)
- Description: Used to indicate
additional information about the document description as a
whole. "Notes" sections appear in several places in the DTD. The
attributes for notes permit a controlled vocabulary to be developed
(type and subject), the level of the DTD to which the note refers to
be identified (study, file, variable, etc.), and the author of the
note to be indicated (resp).
- Example:
<notes>This Document Description, or header information, can be used
within an electronic resource discovery environment.</notes>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, type, subject, level, resp
- Contains: #PCDATA, Link to other
element(s) within the codebook, reference to a table.
Study Description
Document
|---Document Description
|---STUDY DESCRIPTION
|---Data Files Description
|---Variable Description
|---Other Study-Related Materials
Role of the Study Description
The Study Description consists of information about the data
collection, study, or compilation that the DDI-compliant
documentation file describes. This section includes information about
how the study should be cited, who collected or compiled the data, who
distributes the data, keywords about the content of the data, summary
(abstract) of the content of the data, data collection methods and
processing, etc. Note that some content of the Study Description's
Citation -- e.g., Responsibility Statement -- may be identical to
that of the Documentation Citation. This is usually the case when
the producer of a data collection also produced the print or
electronic codebook for that data collection.
Study Description
- The access attribute is used to link to the Access Conditions element
describing access and terms of use for the entire dataset.
- Required
- Repeatable
- Attributes: ID, xml:lang, source,
access
- Contains Elements:
- Citation (of Study)
- Required
- Repeatable
- Attributes: ID, xml:lang, source
- Study Scope
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Methodology and Processing (Study Level)
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Data Access
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Other Study Description Materials
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
Citation
Citation's Place within the Study Description
Document
|
|---Document Description
|---Study Description
| |---CITATION
| |---Study Scope
| |---Methodology
| |---Data Access
| |---Other Study Description Materials
|
|---Data Files Description
|---Variables Description
|---Other Study-Related Materials
- <citation> 2.1 (Generic element A.6)
- Description: Citation for the data collection
described by the marked-up documentation. This element encodes the
bibliographic information describing the data collection, including title
information, statement of responsibility, production and distribution
information, series and version information, text of a preferred
bibliographic citation, and notes (if any).
A MARCURI attribute is provided to
link to the MARC record for this citation.
- Optional
- Not Repeatable
-
Attributes: ID, xml:lang, source, MARCURI
- Contains Elements:
Title Statement -- Data Collection,
Responsibility Statement -- Data Collection
Production Statement -- Data Collection,
Distributor Statement -- Data Collection,
Series Statement -- Data Collection,
Version Statement -- Data Collection,
Bibliographic Citation -- Data Collection,
Holdings Information -- Data Collection,
Notes (Citation) -- Data Collection
- Title Statement -- Data Collection
- <titlStmt> 2.1.1 (Generic element A.6.1)
- Description: Title statement for the
data collection..
- Required
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains Elements:
Title -- Data Collection,
Subtitle -- Data Collection,
Alternative Title -- Data Collection,
Parallel Title -- Data Collection,
ID Number -- Data Collection
- Title -- Data Collection
- <titl> 2.1.1.1 (Generic element A.6.1.1)
- Description: Contains the full authoritative title of the data
collection. The data collection title will in most cases be identical
to the title for the marked-up document (1.1.1.1) and the source document
(1.4.1.1). A full title should
indicate the geographic scope of the data collection as well as the
time period covered.
- Examples:
<titl>Domestic Violence Experience in Omaha, Nebraska, 1986-1987</titl>
<titl>Census of Population, 1950 [United States]: Public Use
Microdata Sample</titl>
<titl>Monitoring the Future: A Continuing Study of American Youth, 1995</titl>
- Required
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Subtitle -- Data Collection
- <subTitl> 2.1.1.2 (Generic element A.6.1.2)
- Description: A subtitle is a secondary title used to amplify or state certain limitations of the main title. It may repeat information already in the main title.
- Examples:
<titl>Monitoring the Future: A Continuing Study of American Youth, 1995</titl>
<subTitl>A Continuing Study of American Youth, 1995</subTitl>
<titl>Census of Population, 1950 [United States]: Public Use
Microdata Sample</titl>
<subTitl>Public Use Microdata Sample</subTitl>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Alternative Title -- Data Collection
- <altTitl> 2.1.1.3 (Generic element A.6.1.3)
- Description: The alternative title may be the title by which a data collection is commonly referred to or it may be an abbreviation for the title.
- Examples:
<titl>Census of Population, 1950 [United States]: Public Use
Microdata Sample</titl>
<altTitl>PUMS</altTitl>
<titl>Equality of Educational Opportunity (Coleman) Study
(EEOS), 1996</titl>
<altTitl>The Coleman Study</altTitl>
<altTitl>EEOS</altTitl>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Parallel Title -- Data Collection
- <parTitl> 2.1.1.4 (Generic element A.6.1.4)
- Description: The title translated into another language.
- Example:
<titl>Politbarometer West [Germany], Partial
Accumulation, 1977-1995</titl>
<parTitl>Politbarometer, 1977-1995: Partielle Kumulation</parTitl>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains: #PCDATA, Link to other element(s) within the codebook.
- ID Number -- Data Collection
- <IDNo> 1.1.1.5 (Generic element A.6.1.5)
- Description: Unique string or number
(producer's or archive's number) for the data collection. An "agency"
attribute is supplied.
- Examples:
<IDNo agency='ICPSR'>6678</IDNo>
<IDNo agency='ZA'>2010</IDNo>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, agency
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Responsibility Statement -- Data Collection
- <rspStmt> 1.1.2 (Generic element A.6.2)
- Description: Responsibility for the data collection.
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains Elements:
Authoring Entity / Primary Investigator -- Data Collection,
Other Identifications / Acknowledgments -- Data Collection
- Authoring Entity / Primary Investigator -- Data Collection
- <AuthEnty> 1.1.2.1 (Generic element A.6.2.1)
- Description: The person, corporate
body, or agency responsible for the data collection's substantive and
intellectual content. Repeat the element for each
author, and use the affiliation attribute if available. Invert first and
last name and use commas.
Remarks: The author in this element
should be the individual(s) or organization(s) directly
responsible for the intellectual content of the data collection, as
distinct from the person(s) or organization(s) responsible for the
intellectual content of the marked-up document.
- Examples:
<AuthEnty>United States Department of Commerce. Bureau of the Census</AuthEnty>
<AuthEnty affiliation='European Commission'>Rabier, Jacques-Rene</AuthEnty>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, affiliation
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Other Identifications / Acknowledgments -- Data Collection
- <othId> 2.1.2.2 (Generic element A.6.2.2)
- Description: Statements of
responsibility not recorded in the title and statement of
responsibility areas. Indicate here the persons or bodies connected
with the work, or significant persons or bodies connected with
previous editions and not already named in the description. For
example, the name of the person who cleaned the data collection might be cited
here, using the role and affiliation attributes.
- Example:
<othId role='processor' affiliation='INRA'>Jane Smith</othId>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, type, role, affiliation
- Contains: <p>, othId
- Production Statement -- Source Document
- <prodStmt> 2.1.3 (Generic element A.6.3)
- Description: Production statement for the data collection.
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains Elements:
Producer -- Data Collection,
Copyright -- Data Collection,
Date of Production -- Data Collection,
Place of Production -- Data Collection,
Software Used in Production -- Data Collection,
Funding Agency -- Data Collection,
Grant Number -- Data Collection
- Producer -- Data Collection
- <producer> 2.1.3.1 (Generic element A.6.3.1)
- Description: 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.
- Example:
<producer abbr='ICPSR' affiliation='Institute for Social Research'>Inter-university Consortium for Political and Social Research</producer>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, abbr, affiliation, role
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Copyright -- Data Collection
- <copyright> 2.1.3.2 (Generic element A.6.3.2)
- Description: Copyright statement for the data collection.
- Example:
<copyright>Copyright(c) ICPSR, 2000</copyright>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Date of Production -- Data Collection
- <prodDate> 2.1.3.3 (Generic element A.6.3.3)
- Description: Date the data collection
was produced (not distributed or archived). The ISO
standard for dates (YYYY-MM-DD) is recommended for use with the date
attribute.
- Example:
<prodDate date='1998-07-21'>July 21, 1998</prodDate>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, date
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Place of Production -- Data Collection
- <prodPlac> 2.1.3.4 (Generic element A.6.3.4)
- Description: Address of the archive or agency that produced the data collection.
- Example:
<prodPlac>Ann Arbor, MI: Inter-university Consortium for Political and Social Research</prodPlac>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Software Used in Production -- Data Collection
- <software> 2.1.3.5 (Generic element A.6.3.5)
- Description: Identifies the software
used in creating or storing the data collection. A "version" attribute
permits specification of the software version number. The "date"
attribute is provided to enable specification of the date (if any) for
the software release. The ISO standard for dates (YYYY-MM-DD) is
recommended for use with the date attribute.
- Example:
<software version='6.12'>SAS</software>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, version, date
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Funding Agency -- Data Collection
- <fundAg> 2.1.3.6 (Generic element A.6.3.6)
- Description: The source(s) of funds
for production of the data collection. If different funding agencies
sponsored different stages of the production process, use the role
attribute to distinguish them.
- Example:
<fundAg abbr='NSF'>National Science Foundation</fundAg>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, abbr, role
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Grant Number -- Data Collection
- <grantNo> 2.1.3.7 (Generic element A.6.3.7)
- Description: The grant/contract
number of the project that sponsored the data collection effort. If
more than one, indicate the appropriate agency using the "agency"
attribute. If different funding agencies
sponsored different stages of the production process, use the role
attribute to distinguish the grant numbers.
- Example:
<grantNo agency='Bureau of Justice Statistics'>J-LEAA-018-77</grantNo>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, agency, role
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Distributor Statement -- Data Collection
- <distStmt> 2.1.4 (Generic element A.6.4)
- Description: Distribution statement
for the data collection.
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains Elements:
Distributor -- Data Collection,
Contact Person -- Data Collection,
Depositor -- Data Collection,
Date of Deposit -- Data Collection,
Date of Distribution -- Data Collection
- Distributor -- Data Collection
- <distrbtr> 2.1.4.1 (Generic element A.6.4.1)
- Description: The organization
designated by the author or producer to generate copies of a
particular data collection including any necessary editions or
revisions. Names and addresses may
be specified, and other archives may be co-distributors. A URI
attribute is included to provide an URN or URL to the ordering service
or download facility on a website.
- Example:
<distrbtr abbr='ICPSR" affiliation='Institute for Social
Research' URI='http://www.icpsr.umich.edu'>Ann Arbor, MI: Inter-university Consortium for Political
and Social Research</distrbtr>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, abbr, affiliation, URI
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Contact Person -- Data Collection
- <contact> 2.1.4.2 (Generic element A.6.4.2)
- Description: Names and addresses of individuals responsible for the data collection. May be PIs. Individuals listed as contact persons will be used as resource persons regarding problems or questions raised by the user community. The URI attribute should be used to indicate a URN or URL for the homepage of the contact individual. The email attribute is used to indicate an email address for the contact individual.
- Example:
<contact affiliation='University of Wisconsin' email="jsmith@...'>Jane Smith</contact>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, affiliation, URI, email
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Depositor -- Data Collection
- <depositr> 2.1.4.3 (Generic element A.6.4.3)
- Description: The name of the person (or institution) who provided this data collection to the archive storing it.
- Example:
<depositr abbr='BJS' affiliation='U.S. Department of Justice'>Bureau of Justice Statistics</depositr>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, abbr, affiliation
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Date of Deposit -- Data Collection
- <depDate> 2.1.4.4 (Generic element A.6.4.4)
- Description: The date that the data
collection was deposited with the archive that originally received
it. The ISO
standard for dates (YYYY-MM-DD) is recommended for use with the date
attribute.
- Example:
<depDate date='1999-01-25'>January 25, 1999</depDate>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, date
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Date of Distribution -- Data Collection
- <distDate> 2.1.4.5 (Generic element A.6.4.5)
- Description: The date that the data
collection was released for distribution. The ISO
standard for dates (YYYY-MM-DD) is recommended for use with the date
attribute.
- Example:
<distDate date='1999-01-25'>January 25, 1999</distDate>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, date
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Series Statement -- Data Collection
- <serStmt> 2.1.5 (Generic element A.6.5)
- Description: Series statement for the
data collection. The URI attribute is provided to point to a central
Internet repository of series information.
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, URI
- Contains Elements:
Series Name -- Data Collection,
Series Information -- Data Collection
- Series Name -- Data Collection
- <serName> 2.1.5.1 (Generic element A.6.5.1)
- Description: The name of the data series to which the collection belongs
- Example:
<serName abbr='CPS'>Current Population Survey Series</serName>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, abbr
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Series Information -- Data Collection
- <serInfo> 2.1.5.2 (Generic element A.6.5.2)
- Description: Contains a history of
the data series and a summary of those features that apply to the
data series as a whole.
- Example:
<serInfo>The Current Population Survey (CPS) is
a household sample survey conducted monthly by the Census Bureau to
provide estimates of employment, unemployment, and other characteristics
of the general labor force, estimates of the population as a whole,
and estimates of various subgroups in the population. The entire
non-institutionalized population of the United States is sampled to
obtain the respondents for this survey series.</serInfo>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Version Statement -- Data Collection
- <verStmt> 2.1.6 (Generic element A.6.6)
- Description: Version statement for
the data collection.
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains Elements:
Version -- Data Collection,
Version Responsibility Statement -- Data Collection,
Notes (Version) -- Data Collection
- Version -- Data Collection
- <version> 2.1.6.1 (Generic element A.6.6.1)
- Description: Also known as release or
edition. If there have been substantive changes in the data collection
since its creation, this statement should be used. The ISO
standard for dates (YYYY-MM-DD) is recommended for use with the date
attribute.
Remarks: ICPSR distinguishes among the terms "release," "version," and
"edition" in the following ways:
- ICPSR Edition: Used only
for intensively processed collections, for which ICPSR has produced a
unique edition of the data. This usually involves checking for
undocumented codes and consistency checks. Signals that additional
intellectual effort has gone into producing the collection.
- ICPSR Version: Used to indicate that
ICPSR has revised the format of a collection or added components
to it, in most cases without
changing any data values. A study is considered an "ICPSR version"
if one or more of these steps has been performed:
(1) Converting software-specific system files or export/transport
files to raw data;
(2) Generating SAS and/or SPSS data definition statements;
(3) Reformatting files, e.g., removing blanks to use space more
efficiently;
(4)Scanning hardcopy documentation; or
(5)Reformatting machine-readable documentation, e.g., converting
text created in a word-processing package to ASCII text.
- Release: Used for data collections that are
being disseminated exactly as they came from the data depositor
(except for the addition of an ICPSR cover and ICPSR front matter).
- Example:
<version type='edition' date='1999-01-25'>Second ICPSR Edition</version>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, type (release, version, edition), date
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Version Responsibility Statement -- Data Collection
- <verResp> 2.1.6.2 (Generic element A.6.6.2)
- Description: Used to indicate the
organization or person responsible for the version of the data
collection.
- Example:
<verResp>Zentralarchiv fuer Empirische Sozialforschung</verResp>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, affiliation
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Notes (Version) -- Data Collection
- <notes> 2.1.6.3 (Generic element A.6.6.3)
- Description: Used to indicate
additional information regarding the version or the version
responsibility statement for the data collection, in particular to indicate what makes a new
version differnt from its predecessor. "Notes" sections appear in
several places in the DTD. The attributes for notes permit a
controlled vocabulary to be developed (type and subject), the level of
the DTD to which the note refers to be identified (study, file,
variable, etc.), and the author of the note to be indicated
(resp).
- Example:
<notes resp='Jane Smith'>Data for 1998 have been added to this version of the data collection.</notes>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, type, subject level, resp
- Contains: #PCDATA, Link to other
element(s) within the codebook, reference to a table.
- Bibliographic Citation -- Data Collection
- <biblCit format='MRDF'> 2.1.7 (Generic element A.6.7)
- Description: Complete bibliographic reference containing all of the standard elements of a citation that can be used to cite the data collection. The "format" attribute is provided to enable specification of the particular citation style used, e.g. APA, MLA, Chicago, etc.
- Example:
<biblCit>Rabier, Jacques-Rene, and Ronald
Inglehart. EURO-BAROMETER 11: YEAR OF THE CHILD IN EUROPE, APRIL 1979
[Computer file]. Conducted by Institut Francais D'Opinion Publique
(IFOP), Paris, et al. ICPSR ed. Ann Arbor, MI: Inter-university
Consortium for Political and Social Research [producer and
distributor], 1981. </biblCit>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, format
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Holdings Information -- Data Collection
- <holdings> 2.1.8 (Generic element A.6.8)
- Description: Information concerning
either the physical or electronic holdings of the cited work. Attributes
include: location--The physical location where a copy is held;
callno--The call number for a work at the location specified; and
URI--A URN or URL for accessing the electronic copy of the cited
work.
- Example:
<holdings location='University of Michigan Graduate Library callno='inap.'
URI='http://www.umich.edu/library/'>
Data File for Current Population Survey, 1999: Annual Demographic
File</holdings>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, location, callno, URI
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Notes (Citation) -- Data Collection
- <notes> 2.1.9 (Generic element A.4)
- Description: Used to indicate
additional information regarding the citation for the data collection.
"Notes" sections appear in
several places in the DTD. The attributes for notes permit a
controlled vocabulary to be developed (type and subject), the level of
the DTD to which the note refers to be identified (study, file,
variable, etc.), and the author of the note to be indicated
(resp).
- Example:
<notes resp='Jane Smith'>This citation was sent to ICPSR by the
agency depositing the data.</notes>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, type, subject level, resp
- Contains: #PCDATA, Link to other
element(s) within the codebook, reference to a table.
Study Scope
Study Scope's Place within the Document Structure
Document
|
|---Document Description
|---Study Description
| |---Citation
| |---STUDY SCOPE
| |---Methodology And Processing (Study Level)
| |---Data Access
| |---Other Study Description Materials (Encoder-defined)
|
|---Data Files Description
|---Variable Description
|---Other Study-Related Materials
To comply with the Dublin Core, it is recommended that the following
elements in the Study Scope section be used when the appropriate
information is available:
DUBLIN CORE DDI
------------------
Subject 2.2.1.1 keyword (Keywords)
2.2.1.2 topcClas (Topic Classification)
Description 2.2.2 abstract (Abstract)
Coverage 2.2.3.1 timePrd (Time Period Covered)
2.2.3.2 collDate (Date of Collection)
2.2.3.3 nation (Country)
2.2.3.4 geogCover (Geographic Coverage)
- Study Scope
- <stdyInfo> 2.2
- Description: This section contains information about the data collection's
scope across several dimensions, including substantive content, geography,
and time.
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains: Subject Information,
Abstract,
Summary Data Description,
Notes
- Subject Information
- <subject> 2.2.1
- Description: Subject information describing the data collection's
intellectual content.
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains:
Keyword,
Topic Classification
- Keyword
- <keyword> 2.2.1.1
- Description: Words or phrases that
describe salient aspects of a data collection's content. Can be used for
building keyword indexes and for classification and retrieval purposes. A
controlled vocabulary can be employed. Maps to Dublin Core
Subject. The vocab attribute is provided for specification of the
controlled vocabulary in use, e.g., LCSH, MeSH, etc. The vocabURI attribute
specifies the location for the full controlled vocabulary.
- Examples:
<keyword>quality of life</keyword>
<keyword>family</keyword>
<keyword>career goals</keyword>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, vocab, vocabURI
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Topic Classification
- <topcClas> 2.2.1.2
- Description: The classification field indicates
the broad substantive topic(s) that the data cover. Library of
Congress subject terms may be used here. The vocab attribute is
provided for specification of the controlled vocabulary in use, e.g.,
LCSH, MeSH, etc. The vocabURI attribute specifies the location for the
full controlled vocabulary. Maps to Dublin Core Subject.
- Examples:
<topcClas ICPSR Subject Headings>Mass Political Behavior and Attitudes</topcClas>
<topcClas ICPSR Subject Headings>Social Indicators</topcClas>
<topcClas vocab='LOC Subject Headings'>Public opinion -- California -- Statistics</topcClas>
<topcClas vocab='LOC Subject Headings'>Elections -- California</topcClas>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, vocab, vocabURI
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Abstract
- <abstract> 2.2.2
- Description: 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. Inclusion of this element is recommended.
Date attribute should follow ISO convention of YYYY-MM-DD.
- Example:
<abstract date = '1999-01-28' source='ICPSR'> 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.</abstract>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, date
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Summary Data Description
- <sumDscr> 2.2.3
- Description: Information about a study's chronological and
geographic coverage and unit of analysis.
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains:
Time Period Covered,
Date of Collection,
Country,
Geographic Coverage,
Geographic Unit,
Unit of Analysis,
Universe,
Kind of Data
- Time Period Covered
- <timePrd> 2.2.3.1
- Description: The time period to which the data
refer. This item reflects the time period covered by the data, not the
dates of coding or making documents machine-readable or the dates the
data were collected. Also known as span. Use the event attribute to specify
"start", "end", or "single" for each date entered. The ISO
standard for dates (YYYY-MM-DD) is recommended for use with the date
attribute. Maps to Dublin Core Coverage. Inclusion of this element is recommended.
- Examples:
<timePrd event='start' date='1998-05-01'>May 1, 1998</timePrd>
<timePrd event='end' 'date=1998-05-31'>May 31, 1998</timePrd>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, event, date
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Date of Collection
- <collDate> 2.2.3.2
- Contains the date(s) when the data were collected. Use the event
attribute to specify "start", "end", or
"single" for each date entered to distinguish between, for example,
the first day of collection (start), only day of collection (single),
and last day of collection (end). The ISO standard for dates
(YYYY-MM-DD) is recommended for use with the date attribute.
Maps to Dublin Core Coverage. Inclusion of this element in the codebook is recommended.
- Example:
<collDate event='single' date='1998-11-10'>10 November 1998</collDate>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, event, date
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Country
- <nation> 2.2.3.3
- Description: Indicates the country or countries
covered in the file. Attribute "abbr" may be used to match the
attributes given to agencies, etc. and to provide an equivalent to the TEI
placePart entity, which adds "type" and "full" attributes.
Maps to Dublin Core Coverage. Inclusion of this element is recommended.
- Example:
<nation abbr='U.K.'>United Kingdom</nation>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, abbr
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Geographic Coverage
- <geogCover> 2.2.3.4
- Information on the geographic
coverage of the data. Include the total geographic scope of
the data, and any additional levels of geographic coding provided in
the variables. Maps to Dublin Core Coverage. Inclusion of this element is recommended.
Example:
<geogCover>State of California</geogCover>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains #PCDATA.
- Geographic Unit
- <geogUnit> 2.2.3.5
- Description: Lowest level of geographic aggregation covered by the data.
- Example:
<geogUnit>state</geogUnit>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Unit of Analysis
- <anlyUnit> 2.2.3.6
- Description: Basic unit of analysis or observation
that the file describes: individuals, families/households, groups,
institutions/organizations, administrative units, etc. The "unit" attribute
is included to permit the development of a controlled vocabulary for this
element.
- Example:
<anlyUnit>individuals</anlyUnit>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, unit
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Universe
- <universe> 2.2.3.7
- Description: A description of the population
covered by the data in the file; the group of persons or other
elements that are the object of the study and to which the study
results refer. Age, nationality, and residence commonly help to
delineate a given universe, but any of a number of factors may be
involved, such as age limits, sex, marital status, race, ethnic group,
nationality, income, veteran status, criminal convictions, etc. The
universe may consist of elements other than persons, such as housing
units, court cases, deaths, countries, etc. In general, it should be
possible to tell from the description of the universe whether a given
individual or element (hypothetical or real) is a member of the
population under study. Also known as universe of interest, population
of interest, and target population. A "level" attribute is included to
permit coding of the level to which universe applies, i.e., the study
level, the file level (if different from study), or the variable level.
The "clusion" attribute provides for specification of groups included (I) in
or excluded (E) from the universe.
- Example:
For a universe that excludes persons living in institutions or military
barracks:
<universe level='study' clusion='I'>The resident
population of the United States.</universe>
<universe level='study' clusion='E'>Persons living in
institutions and military barracks.</universe>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, level, clusion
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Kind of Data
- <dataKind> 2.2.3.8
- Description: The type of data included in the file: survey data, census/enumeration
data, aggregate data, clinical data, event/transaction data, program
source code, machine-readable text, administrative records data,
experimental data, psychological test, textual data, coded textual,
coded documents, time budget diaries, observation data/ratings,
process-produced data, etc.
- Example:
<dataKind>survey data</dataKind>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Notes
- <notes> 2.2.4 (Generic element A.4)
- Description: Used to indicate additional information
regarding the scope of a data collection. "Notes" sections appear in several places in
the DTD. The attributes for notes permit a controlled vocabulary to be
developed (type and subject), the level of the DTD to which the note
refers to be identified (study, file, variable, etc.), and the author
of the note to be indicated (resp).
- Example:
<notes>Data on employment and income refer to the
preceding year, although demographic data refer to the time of the
survey.</notes>
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source, type, subject, level, resp
- Contains: #PCDATA, Link to other
element(s) within the codebook, reference to a table.
Study Level Methodology and Processing
Document
|
|---Document Description
|---Study Description
| |
| |---Citation
| |---Study Scope
| |---METHODOLOGY AND PROCESSING
| |---Data Access
| |---Other Study Description Materials
|
|---Data Files Description
|---Variable Description
|---Other Study-Related Materials
Methodology and Processing
- <method> 2.3
- Description: This section describes the methodology and processing
involved in a data collection.
- Optional
- Repeatable
- Attributes: ID, xml:lang, source
- Contains: Data Collection Methodology,
Notes,
Data Appraisal,
Study Status
- Data Collection Methodology
- <dataColl> 2.3.1
- Description: Information about the methodology employed in a
data collection.
- Optional
- Not Repeatable
- Attributes: ID, xml:lang, source
- Contains: Time Method,
Data Collector,
Frequency,
Sampling Procedure,
Major Deviations from Sample Design,
Mode of Data Collection,
Type of Research Instrument,
Sources Statement,
Characteristics of the Data Collection Situation,
Actions to Minimize Losses,
Control Operations,
Weighting,
Cleaning Operations
- Time Method
- <timeMeth> 2.3.1.1
- The time method or time dimension of
the data collection. The "method" attribute is included to permit the
development of a controlled vocabulary for this element.
- Examples:
<timeMeth>panel survey</timeMeth>
<timeMeth>cross-section</timeMeth>
<timeMeth>trend study</timeMeth>
<timeMeth>time-series</timeMeth>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, method
- Contains: #PCDATA, Link to other element(s) within the codebook.
- Data Collector
- <dataCollector> 2.3.1.2
- Description: The entity (individual, agency, or
institution) responsible for administering the questionnaire or
interview or compiling the data. This refers to the entity collecting the data,
not to the entity producing the documentation.
- Example:
<dataCollector abbr='SRC' affil='University of Michigan'>Survey Research
Center</dataCollector>
- Optional
- Repeatable
- Attributes: ID, xml:lang, source, abbr, affi
|