OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

clr-dev message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]


Subject: Sample file of DDI controlled vocabularies


Dear all,

The DDI Alliance is working on controlled vocabularies (CVs) which 
support the DDI specification. The CVs are realized in Genericode. We 
plan to publish the first set of CVs soon.

The Data Documentation Initiative (DDI) is an effort to create an 
international standard for describing data from the social, behavioral, 
and economic sciences. Further information is available at:
http://www.ddialliance.org/

Attached is a sample CV in Genericode. I tried to build the structure 
according to the documentation of Genericode and according to earlier 
valuable comments of Tony and Ken. I would be interested in feedback on 
how Genericode is used for this purpose.

Hierarchies in the code values are indicated by the separator dot 
(example: TimeSeries.Discrete). A fixed amount of columns is preferred. 
Therefore the hierarchical values are not in separate columns. The 
hierarchy depth is not known for future CVs.

Multiple languages in a description column are realized by a complex 
value (currently only one language included).

Additional documentation sections are included in Annotation using HTML 
div elements with a class attribute. An application can recognize the 
required section by the value of the class attribute. 
Application-specific information is provided in key/value pairs in the 
AppInfo.

I would appreciate any comments on the sample file.

Cheers,
Achim

-- 
GESIS - Leibniz Institute for the Social Sciences
Department: Monitoring Society and Social Change
Unit: Social Science Metadata Standards
Visiting address: B2 1, 68159 Mannheim, Germany
Postal address: P.O. Box 122155, 68072 Mannheim, Germany
Phone: +49 (0)621 1246 262
Fax: +49 (0)621 1246 100
E-mail: joachim.wackerow@gesis.org
www.gesis.org/en/institute/
<?xml version="1.0" encoding="UTF-8"?><gc:CodeList xmlns:gc="http://docs.oasis-open.org/codelist/ns/genericode/1.0/"; xmlns:ddicv="urn:ddicv" xmlns:h="http://www.w3.org/1999/xhtml"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://docs.oasis-open.org/codelist/ns/genericode/1.0/ http://docs.oasis-open.org/codelist/cs-genericode-1.0/xsd/genericode.xsd";>
    <!--

DDI Controlled Vocabulary TimeMethod 1.0.0

Copyright © DDI Alliance (http://www.ddialliance.org/) 2011.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

This work is licensed under a
Creative Commons Attribution-ShareAlike 3.0 Unported License.
 
You are free:
 
    * to Share - to copy, distribute and transmit the work
    * to Remix - to adapt the work
 
Under the following conditions:
 
    * Attribution - You must attribute the work in the manner specified by
      the author or licensor (but not in any way that suggests that they 
      endorse you or your use of the work).
    * Share Alike - If you alter, transform, or build upon this work, you
      may distribute the resulting work only under the same or similar
      license to this one.
 
With the understanding that:
 
    * Waiver - Any of the above conditions can be waived if you get
      permission from the copyright holder.
    * Public Domain - Where the work or any of its elements is in the
      public domain under applicable law, that status is in no way 
      affected by the license.
    * Other Rights - In no way are any of the following rights affected by
      the license:
          - Your fair dealing or fair use rights, or other applicable 
            copyright exceptions and limitations;
          - The author's moral rights;
          - Rights other persons may have either in the work itself or in 
            how the work is used, such as publicity or privacy rights.
    * Notice - For any reuse or distribution, you must make clear to
      others the license terms of this work. The best way to do this is 
      with a link to this web page.
 
This is a human-readable summary of the Legal Code (the full license).
 
Human-readable summary:
http://creativecommons.org/licenses/by-sa/3.0/
 
Full license:
http://creativecommons.org/licenses/by-sa/3.0/legalcode

-->
    <Annotation>
        <Description>
            <h:div xml:lang="en-US" class="Description">
                <h:p>Describes the time dimension of the data collection.</h:p>
            </h:div>
            <h:div class="Usage">
                <h:div class="DDI3.1">
                    <h:div class="UsageTitle">
                        <h:p>
                            <a href="http://www.ddialliance.org/Specification/DDI-Lifecycle/3.1";>DDI 3.1</a>
                        </h:p>
                    </h:div>
                    <h:table class="UsageDetails">
                        <h:thead>
                            <h:tr>
                                <h:th>Module Name</h:th>
                                <h:th>Element Name</h:th>
                            </h:tr>
                        </h:thead>
                        <h:tbody>
                            <h:tr>
                                <h:td>DataCollection</h:td>
                                <h:td>
                                    <h:a href="http://www.ddialliance.org/sites/default/files/documentation/ddi3.1/schemas/datacollection_xsd/elements/TimeMethod.html";>TimeMethod</h:a>
                                </h:td>
                            </h:tr>
                        </h:tbody>
                    </h:table>
                </h:div>
                <h:div class="DDI2.1">
                    <h:div class="UsageTitle">
                        <h:p>
                            <a href="http://www.ddialliance.org/Specification/DDI-Codebook/2.1";>DDI 2.1</a>
                        </h:p>
                    </h:div>
                    <h:table class="UsageDetails">
                        <h:thead>
                            <h:tr>
                                <h:th>Element Number</h:th>
                                <h:th>Element/Attribute Name</h:th>
                            </h:tr>
                        </h:thead>
                        <h:tbody>
                            <h:tr>
                                <h:td>2.3.1.1</h:td>
                                <h:td>
                                    <h:a href="http://www.ddialliance.org/sites/default/files/dtd/Details/Version2-1.xsd@element-definition=timeMethType&amp;amp;reps=%252A.html";>timeMeth@method</h:a>
                                </h:td>
                            </h:tr>
                        </h:tbody>
                    </h:table>
                </h:div>
            </h:div>
        </Description>
        <AppInfo>
            <ddicv:Value key="LicenseName">Creative Commons Attribution-ShareAlike 3.0 Unported License.</ddicv:Value>
            <ddicv:Value key="LicenseURL">http://creativecommons.org/licenses/by-sa/3.0/</ddicv:Value>
            <ddicv:Value key="CopyrightText">Copyright ©</ddicv:Value>
            <ddicv:Value key="CopyrightOwner">DDI Alliance</ddicv:Value>
            <ddicv:Value key="CopyrightOwnerURL">http://www.ddialliance.org/</ddicv:Value>
            <ddicv:Value key="CopyrightYear">2011</ddicv:Value>
        </AppInfo>
    </Annotation>
    <Identification>
        <ShortName>TimeMethod</ShortName>
        <LongName xml:lang="en-US">Time Method</LongName>
        <Version>1.0.0</Version>
        <CanonicalUri>urn:ddicv:TimeMethod</CanonicalUri>
        <CanonicalVersionUri>urn:ddicv:TimeMethod:1.0.0</CanonicalVersionUri>
        <LocationUri>http://www.ddialliance.org/Specification/DDI-CV/TimeMethod/1.0.0/Genericode1.0_DDICVProfile1.0.xml</LocationUri>
        <AlternateFormatLocationUri MimeType="text/html">http://www.ddialliance.org/Specification/DDI-CV/TimeMethod/1.0.0/HumanReadable.html</AlternateFormatLocationUri>
        <AlternateFormatLocationUri MimeType="application/vnd.ms-excel">http://www.ddialliance.org/Specification/DDI-CV/TimeMethod/1.0.0/InputSheet_Excel_2003.xls</AlternateFormatLocationUri>
        <Agency>
            <ShortName>DDI Alliance</ShortName>
            <LongName>The Alliance for the Data Documentation Initiative</LongName>
            <Identifier>DDI</Identifier>
        </Agency>
    </Identification>
    <ColumnSet>
        <Column Use="required" Id="Code">
            <Annotation>
                <Description>
                    <h:p>Non-hierarchical structure: just the code (no dots are allowed).</h:p>
                    <h:p>Hierarchical structure: the full code, the levels are separated by dots. Example: Longitudinal.Panel.Continuous</h:p>
                    <h:p>Rules for naming a code:<h:ul>
                            <h:li>only letters are allowed</h:li>
                            <h:li>first letter must be uppercase</h:li>
                            <h:li>CamelCase must be used when using multiple words. Example: TimeMethod</h:li>
                            <h:li>only full words are allowed</h:li>
                            <h:li>abbreviations can only be used when the acronym is better known than the full wording</h:li>
                        </h:ul>
                    </h:p>
                </Description>
            </Annotation>
            <ShortName>Code</ShortName>
            <LongName>Value of the Code</LongName>
            <Data Type="string"/>
        </Column>
        <Column Use="required" Id="Term">
            <ShortName>Term</ShortName>
            <LongName>Descriptive Term of the Code</LongName>
            <Data Type="string"/>
        </Column>
        <Column Use="required" Id="Definition">
            <ShortName>Definition</ShortName>
            <LongName>Definition of the Code</LongName>
            <Data Type="string"/>
        </Column>
        <Key Id="CodeKey">
            <ShortName>CodeKey</ShortName>
            <LongName>The unique identification of each item in a code list.</LongName>
            <ColumnRef Ref="Code"/>
        </Key>
    </ColumnSet>
    <SimpleCodeList>
        <Row>
            <Value ColumnRef="Code">
                <SimpleValue>Longitudinal</SimpleValue>
            </Value>
            <Value ColumnRef="Term">
                <ComplexValue>
                    <ddicv:Value xml:lang="en-US">Longitudinal</ddicv:Value>
                </ComplexValue>
            </Value>
            <Value ColumnRef="Definition">
                <ComplexValue>
                    <ddicv:Value xml:lang="en-US">Data collected repeatedly over time to study change in a population.</ddicv:Value>
                </ComplexValue>
            </Value>
        </Row>
        <Row>
            <Value ColumnRef="Code">
                <SimpleValue>Longitudinal.CohortEventBased</SimpleValue>
            </Value>
            <Value ColumnRef="Term">
                <ComplexValue>
                    <ddicv:Value xml:lang="en-US">Longitudinal: Cohort/Event-based</ddicv:Value>
                </ComplexValue>
            </Value>
            <Value ColumnRef="Definition">
                <ComplexValue>
                    <ddicv:Value xml:lang="en-US">Data collected over time about a group of individuals that are connected in some way or have shared some significant experience within a given period. Examples: birth, disease, education, employment, family formation, participation in an event.</ddicv:Value>
                </ComplexValue>
            </Value>
        </Row>
        <Row>
            <Value ColumnRef="Code">
                <SimpleValue>Longitudinal.TrendRepeatedCrossSection</SimpleValue>
            </Value>
            <Value ColumnRef="Term">
                <ComplexValue>
                    <ddicv:Value xml:lang="en-US">Longitudinal: Trend/Repeated cross-section</ddicv:Value>
                </ComplexValue>
            </Value>
            <Value ColumnRef="Definition">
                <ComplexValue>
                    <ddicv:Value xml:lang="en-US">Studies different samples/different groups of people from the same population at several points in time, using the same set of questions/variables. Conclusions are drawn for the population. Examples: public opinion polls, elections studies, etc.</ddicv:Value>
                </ComplexValue>
            </Value>
        </Row>
        <Row>
            <Value ColumnRef="Code">
                <SimpleValue>Longitudinal.Panel</SimpleValue>
            </Value>
            <Value ColumnRef="Term">
                <ComplexValue>
                    <ddicv:Value xml:lang="en-US">Longitudinal: Panel</ddicv:Value>
                </ComplexValue>
            </Value>
            <Value ColumnRef="Definition">
                <ComplexValue>
                    <ddicv:Value xml:lang="en-US">Data collected over time from, or about, the same sample of respondents.</ddicv:Value>
                </ComplexValue>
            </Value>
        </Row>
        <Row>
            <Value ColumnRef="Code">
                <SimpleValue>Longitudinal.Panel.Continuous</SimpleValue>
            </Value>
            <Value ColumnRef="Term">
                <ComplexValue>
                    <ddicv:Value xml:lang="en-US">Longitudinal: Panel: Continuous</ddicv:Value>
                </ComplexValue>
            </Value>
            <Value ColumnRef="Definition">
                <ComplexValue>
                    <ddicv:Value xml:lang="en-US">Reports from the panel are collected on a regular basis.</ddicv:Value>
                </ComplexValue>
            </Value>
        </Row>
        <Row>
            <Value ColumnRef="Code">
                <SimpleValue>Longitudinal.Panel.Interval</SimpleValue>
            </Value>
            <Value ColumnRef="Term">
                <ComplexValue>
                    <ddicv:Value xml:lang="en-US">Longitudinal: Panel: Interval</ddicv:Value>
                </ComplexValue>
            </Value>
            <Value ColumnRef="Definition">
                <ComplexValue>
                    <ddicv:Value xml:lang="en-US">Measurements are taken only when information is needed.</ddicv:Value>
                </ComplexValue>
            </Value>
        </Row>
        <Row>
            <Value ColumnRef="Code">
                <SimpleValue>TimeSeries</SimpleValue>
            </Value>
            <Value ColumnRef="Term">
                <ComplexValue>
                    <ddicv:Value xml:lang="en-US">Time Series</ddicv:Value>
                </ComplexValue>
            </Value>
            <Value ColumnRef="Definition">
                <ComplexValue>
                    <ddicv:Value xml:lang="en-US">Data collected repeatedly over time to study change in observations. These are typically "objective" measurements of phenomena that can be observed externally, as opposed to attitudes/opinions or feelings. Examples may include economic/financial indicators, natural/meteorological phenomena, vital statistics, etc.</ddicv:Value>
                </ComplexValue>
            </Value>
        </Row>
        <Row>
            <Value ColumnRef="Code">
                <SimpleValue>TimeSeries.Continuous</SimpleValue>
            </Value>
            <Value ColumnRef="Term">
                <ComplexValue>
                    <ddicv:Value xml:lang="en-US">TimeSeries: Continuous</ddicv:Value>
                </ComplexValue>
            </Value>
            <Value ColumnRef="Definition">
                <ComplexValue>
                    <ddicv:Value xml:lang="en-US">Phenomena are measured at every instant in time. Examples: lie detectors, electrocardiograms, etc.</ddicv:Value>
                </ComplexValue>
            </Value>
        </Row>
        <Row>
            <Value ColumnRef="Code">
                <SimpleValue>TimeSeries.Discrete</SimpleValue>
            </Value>
            <Value ColumnRef="Term">
                <ComplexValue>
                    <ddicv:Value xml:lang="en-US">TimeSeries: Discrete</ddicv:Value>
                </ComplexValue>
            </Value>
            <Value ColumnRef="Definition">
                <ComplexValue>
                    <ddicv:Value xml:lang="en-US">Measurements are taken at (usually regularly) spaced intervals. Examples: macroeconomics (weekly share prices, monthly profits, sales); meteorology (hourly temperature); measurements of individuals (blood pressure, weight, height); sociology (crime figures, employment figures), etc.</ddicv:Value>
                </ComplexValue>
            </Value>
        </Row>
        <Row>
            <Value ColumnRef="Code">
                <SimpleValue>CrossSection</SimpleValue>
            </Value>
            <Value ColumnRef="Term">
                <ComplexValue>
                    <ddicv:Value xml:lang="en-US">Cross-section</ddicv:Value>
                </ComplexValue>
            </Value>
            <Value ColumnRef="Definition">
                <ComplexValue>
                    <ddicv:Value xml:lang="en-US">Data about a population are obtained only once.</ddicv:Value>
                </ComplexValue>
            </Value>
        </Row>
        <Row>
            <Value ColumnRef="Code">
                <SimpleValue>CrossSectionAdHocFollowUp</SimpleValue>
            </Value>
            <Value ColumnRef="Term">
                <ComplexValue>
                    <ddicv:Value xml:lang="en-US">Cross-section ad-hoc follow-up</ddicv:Value>
                </ComplexValue>
            </Value>
            <Value ColumnRef="Definition">
                <ComplexValue>
                    <ddicv:Value xml:lang="en-US">Data collected at one point in time to complete information collected in a previous cross-sectional study; the decision to collect follow-up data is not included in the study design.</ddicv:Value>
                </ComplexValue>
            </Value>
        </Row>
        <Row>
            <Value ColumnRef="Code">
                <SimpleValue>Other</SimpleValue>
            </Value>
            <Value ColumnRef="Term">
                <ComplexValue>
                    <ddicv:Value xml:lang="en-US">Other</ddicv:Value>
                </ComplexValue>
            </Value>
            <Value ColumnRef="Definition">
                <ComplexValue>
                    <ddicv:Value xml:lang="en-US">Use if the time method is known, but not found in the list. Specify the value in the OtherValue element.</ddicv:Value>
                </ComplexValue>
            </Value>
        </Row>
    </SimpleCodeList>
</gc:CodeList>


[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]