Namespace: |
|
Type: |
|
Content: |
complex, 36 attributes, 26 elements |
Defined: |
globally in codebook.xsd; see XML source |
Used: |
at 1 location |
XML Representation Summary |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
<var | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
> | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
</var> |
This element describes all of the features of a single variable in a social science data file. The following elements are repeatable to support multi-language content: anlysUnit, embargo, imputation, respUnit, security, TotlResp. It includes the following attributes:
The attribute "name" usually contains the so-called "short label" for the variable, limited to eight characters in many statistical analysis systems such as SAS or SPSS.
The attribute "wgt" indicates whether the variable is a weight.
The attribute "wgt-var" references the weight variable(s) for this variable.
The attribute "qstn" is a reference to the question ID for the variable.
The attribute "files" is the IDREF identifying the file(s) to which the variable belongs.
The attribute "vendor" is the origin of the proprietary format and includes SAS, SPSS, ANSI, and ISO.
The attribute "dcml" refers to the number of decimal points in the variable.
The attribute "intrvl" indicates the interval type; options are discrete or continuous.
The "rectype" attribute refers to the record type to which the variable belongs.
The "sdatrefs" are summary data description references which record the ID values of all elements within the summary data description section of the Study Description which might apply to the variable. These elements include: time period covered, date of collection, nation or country, geographic coverage, geographic unit, unit of analysis, universe, and kind of data.
The "methrefs" are methodology and processing references which record the ID values of all elements within the study methodology and processing section of the Study Description which might apply to the variable. These elements include information on data collection and data appraisal (e.g., sampling, sources, weighting, data cleaning, response rates, and sampling error estimates).
The "pubrefs" attribute provides a link to publication/citation references and records the ID values of all citations elements within Other Study Description Materials or Other Study-Related Materials that pertain to this variable.
The attribute "access" records the ID values of all elements in the Data Access section that describe access conditions for this variable.
The "aggrMeth" attribute indicates the type of aggregation method used, for example 'sum', 'average', 'count'. If a value of "other" is given a term from a controlled vocabulary should be used in the "otherAggrMeth" attribute.
The "otherAggrMeth" attribute holds a value from a controlled vocabulary when the aggrMeth attribute has a value of "other".This option should only be used when applying a controlled vocabulary to this attribute. Use the complex element controlledVocabUsed to identify the controlled vocabulary to which the selected term belongs.
The attribute "measUnit" records the measurement unit, for example 'km', 'miles', etc.
The "scale" attribute records unit of scale, for example 'x1', 'x1000', etc.
The attribute "origin" records the point of origin for anchored scales.
The "nature" attribute records the nature of the variable, whether it is 'nominal', 'ordinal', 'interval', 'ratio', or 'percent'. If the 'other' value is used, a value from a controlled vocabulary should be put into the otherNature attribute.
The "otherNature" attribute should be used when the nature attribute has a value of "other". This option should only be used when applying a controlled vocabulary to this attribute. Use the complex element controlledVocabUsed to identify the controlled vocabulary to which the selected term belongs.
The attribute "additivity" records type of additivity, such as 'stock', 'flow', 'non-additive'. When the "other" value is used, a value from a controlled vocabulary should be put into the "otherAdditivity" attribute.
The "otherAdditivity" attribute is used only when the "additivity" attribute has a value of "other". This option should only be used when applying a controlled vocabulary to this attribute. Use the complex element controlledVocabUsed to identify the controlled vocabulary to which the selected term belongs.
The attribute "temporal" indicates whether the variable relays time-related information.
The "geog" attribute indicates whether the variable relays geographic information.
The attribute "geoVocab" records the coding scheme used in the variable.
The attribute "catQnty" records the number of categories found in the variable, and is used primarily for aggregate data files for verifying cell counts in nCubes.
The "representationType" attribute was added to capture the specific DDI 3 representation type to facilitate translation between DDI 2 and DDI 3. If the "other" value is used, a term from a controlled vocabulary may be supplied in the otherRepresentationType attribute.
The "otherRepresentationType" attribute should be used when the representationType attribute has a value of "other". This option should only be used when applying a controlled vocabulary to this attribute. Use the complex element controlledVocabUsed to identify the controlled vocabulary to which the selected term belongs.
<xs:element name="var" type="varType"/> |
Type: |
xs:IDREFS, predefined |
Use: |
optional |
Defined: |
<xs:attribute name="access" type="xs:IDREFS"/> |
Type: |
|
Use: |
optional |
Defined: |
enumeration of xs:NMTOKEN |
Enumeration: |
"stock", "flow", "non-additive", "other" |
Type Derivation Tree xs:NMTOKEN (restriction) simpleType |
Derivation: |
restriction of xs:NMTOKEN |
|||
Facets: |
|
<xs:attribute name="additivity"> <xs:simpleType> <xs:restriction base="xs:NMTOKEN"> <xs:enumeration value="stock"/> <xs:enumeration value="flow"/> <xs:enumeration value="non-additive"/> <xs:enumeration value="other"/> </xs:restriction> </xs:simpleType> </xs:attribute> |
Type: |
|
Use: |
optional |
Defined: |
enumeration of xs:NMTOKEN |
Enumeration: |
"sum", "average", "count", "mode", "median", "maximum", "minimum", "percent", "other" |
Type Derivation Tree xs:NMTOKEN (restriction) simpleType |
Derivation: |
restriction of xs:NMTOKEN |
|||
Facets: |
|
<xs:attribute name="aggrMeth"> <xs:simpleType> <xs:restriction base="xs:NMTOKEN"> <xs:enumeration value="sum"/> <xs:enumeration value="average"/> <xs:enumeration value="count"/> <xs:enumeration value="mode"/> <xs:enumeration value="median"/> <xs:enumeration value="maximum"/> <xs:enumeration value="minimum"/> <xs:enumeration value="percent"/> <xs:enumeration value="other"/> </xs:restriction> </xs:simpleType> </xs:attribute> |
Type: |
xs:string, predefined |
Use: |
optional |
Defined: |
<xs:attribute name="catQnty" type="xs:string"/> |
Type: |
xs:string, predefined |
Use: |
optional |
Defined: |
<xs:attribute name="dcml" type="xs:string"/> |
Type: |
xs:anyURI, predefined |
Use: |
optional |
Defined: |
<xs:attribute name="ddiCodebookUrn" type="xs:anyURI" use="optional"/> |
Type: |
xs:anyURI, predefined |
Use: |
optional |
Defined: |
<xs:attribute name="ddiLifecycleUrn" type="xs:anyURI" use="optional"/> |
Type: |
xs:string, predefined |
Use: |
optional |
Defined: |
<xs:attribute name="elementVersion" type="xs:string" use="optional"/> |
Type: |
|
Use: |
optional |
Defined: |
xs:dateTime | xs:date | xs:gYearMonth | xs:gYear |
<xs:attribute name="elementVersionDate" type="dateSimpleType" use="optional"/> |
Type: |
xs:IDREFS, predefined |
Use: |
optional |
Defined: |
<xs:attribute name="files" type="xs:IDREFS"/> |
Type: |
|
Use: |
optional |
Defined: |
enumeration of xs:NMTOKEN |
Enumeration: |
"Y", "N" |
Default: |
"N" |
Type Derivation Tree xs:NMTOKEN (restriction) simpleType |
Derivation: |
restriction of xs:NMTOKEN |
|||
Facets: |
|
<xs:attribute default="N" name="geog"> <xs:simpleType> <xs:restriction base="xs:NMTOKEN"> <xs:enumeration value="Y"/> <xs:enumeration value="N"/> </xs:restriction> </xs:simpleType> </xs:attribute> |
Type: |
xs:string, predefined |
Use: |
optional |
Defined: |
<xs:attribute name="geoVocab" type="xs:string"/> |
Type: |
xs:ID, predefined |
Use: |
optional |
Defined: |
<xs:attribute name="ID" type="xs:ID" use="optional"/> |
Type: |
|
Use: |
optional |
Defined: |
enumeration of xs:NMTOKEN |
Enumeration: |
"contin", "discrete" |
Default: |
"discrete" |
Type Derivation Tree xs:NMTOKEN (restriction) simpleType |
Derivation: |
restriction of xs:NMTOKEN |
|||
Facets: |
|
<xs:attribute default="discrete" name="intrvl"> <xs:simpleType> <xs:restriction base="xs:NMTOKEN"> <xs:enumeration value="contin"/> <xs:enumeration value="discrete"/> </xs:restriction> </xs:simpleType> </xs:attribute> |
Type: |
xs:string, predefined |
Use: |
optional |
Defined: |
<xs:attribute name="measUnit" type="xs:string"/> |
Type: |
xs:IDREFS, predefined |
Use: |
optional |
Defined: |
<xs:attribute name="methrefs" type="xs:IDREFS"/> |
Type: |
xs:string, predefined |
Use: |
required |
Defined: |
<xs:attribute name="name" type="xs:string" use="required"/> |
Type: |
|
Use: |
optional |
Defined: |
enumeration of xs:NMTOKEN |
Enumeration: |
"nominal", "ordinal", "interval", "ratio", "percent", "other" |
Type Derivation Tree xs:NMTOKEN (restriction) simpleType |
Derivation: |
restriction of xs:NMTOKEN |
|||
Facets: |
|
<xs:attribute name="nature"> <xs:simpleType> <xs:restriction base="xs:NMTOKEN"> <xs:enumeration value="nominal"/> <xs:enumeration value="ordinal"/> <xs:enumeration value="interval"/> <xs:enumeration value="ratio"/> <xs:enumeration value="percent"/> <xs:enumeration value="other"/> </xs:restriction> </xs:simpleType> </xs:attribute> |
Type: |
xs:string, predefined |
Use: |
optional |
Defined: |
<xs:attribute name="origin" type="xs:string"/> |
Type: |
xs:NMTOKEN, predefined |
Use: |
optional |
Defined: |
<xs:attribute name="otherAdditivity" type="xs:NMTOKEN" use="optional"/> |
Type: |
xs:NMTOKEN, predefined |
Use: |
optional |
Defined: |
<xs:attribute name="otherAggrMeth" type="xs:NMTOKEN" use="optional"/> |
Type: |
xs:NMTOKEN, predefined |
Use: |
optional |
Defined: |
<xs:attribute name="otherRepresentationType" type="xs:NMTOKEN" use="optional"/> |
Type: |
xs:IDREFS, predefined |
Use: |
optional |
Defined: |
<xs:attribute name="pubrefs" type="xs:IDREFS"/> |
Type: |
xs:IDREFS, predefined |
Use: |
optional |
Defined: |
<xs:attribute name="qstn" type="xs:IDREFS"/> |
Type: |
xs:string, predefined |
Use: |
optional |
Defined: |
<xs:attribute name="rectype" type="xs:string"/> |
Type: |
|
Use: |
optional |
Defined: |
enumeration of xs:NMTOKEN |
Enumeration: |
"text", "numeric", "code", "datetime", "other" |
Type Derivation Tree xs:NMTOKEN (restriction) simpleType |
Derivation: |
restriction of xs:NMTOKEN |
|||
Facets: |
|
<xs:attribute name="representationType"> <xs:simpleType> <xs:restriction base="xs:NMTOKEN"> <xs:enumeration value="text"/> <xs:enumeration value="numeric"/> <xs:enumeration value="code"/> <xs:enumeration value="datetime"/> <xs:enumeration value="other"/> </xs:restriction> </xs:simpleType> </xs:attribute> |
Type: |
xs:string, predefined |
Use: |
optional |
Defined: |
<xs:attribute name="scale" type="xs:string"/> |
Type: |
xs:IDREFS, predefined |
Use: |
optional |
Defined: |
<xs:attribute name="sdatrefs" type="xs:IDREFS"/> |
Type: |
|
Use: |
optional |
Defined: |
enumeration of xs:NMTOKEN |
Enumeration: |
"archive", "producer" |
Default: |
"producer" |
Type Derivation Tree xs:NMTOKEN (restriction) simpleType |
Derivation: |
restriction of xs:NMTOKEN |
|||
Facets: |
|
<xs:attribute default="producer" name="source"> <xs:simpleType> <xs:restriction base="xs:NMTOKEN"> <xs:enumeration value="archive"/> <xs:enumeration value="producer"/> </xs:restriction> </xs:simpleType> </xs:attribute> |
Type: |
|
Use: |
optional |
Defined: |
enumeration of xs:NMTOKEN |
Enumeration: |
"Y", "N" |
Default: |
"N" |
Type Derivation Tree xs:NMTOKEN (restriction) simpleType |
Derivation: |
restriction of xs:NMTOKEN |
|||
Facets: |
|
<xs:attribute default="N" name="temporal"> <xs:simpleType> <xs:restriction base="xs:NMTOKEN"> <xs:enumeration value="Y"/> <xs:enumeration value="N"/> </xs:restriction> </xs:simpleType> </xs:attribute> |
Type: |
xs:string, predefined |
Use: |
optional |
Defined: |
<xs:attribute name="vendor" type="xs:string"/> |
Type: |
xs:IDREFS, predefined |
Use: |
optional |
Defined: |
<xs:attribute name="weight" type="xs:IDREFS"/> |
Type: |
|
Use: |
optional |
Defined: |
enumeration of xs:NMTOKEN |
Enumeration: |
"wgt", "not-wgt" |
Default: |
"not-wgt" |
Type Derivation Tree xs:NMTOKEN (restriction) simpleType |
Derivation: |
restriction of xs:NMTOKEN |
|||
Facets: |
|
<xs:attribute default="not-wgt" name="wgt"> <xs:simpleType> <xs:restriction base="xs:NMTOKEN"> <xs:enumeration value="wgt"/> <xs:enumeration value="not-wgt"/> </xs:restriction> </xs:simpleType> </xs:attribute> |
Type: |
xs:IDREFS, predefined |
Use: |
optional |
Defined: |
<xs:attribute name="wgt-var" type="xs:IDREFS"/> |
Type: |
xs:NMTOKEN, predefined |
Use: |
optional |
Defined: |
<xs:attribute name="xml-lang" type="xs:NMTOKEN" use="optional"/> |
Type: |
xs:language, predefined |
Use: |
optional |
Defined: |
<xs:attribute ref="xml:lang" use="optional"/> |
Type: |
conceptualTextType, mixed content |
Defined: |
<xs:element maxOccurs="unbounded" minOccurs="0" ref="anlysUnit"/> |
Type: |
catgryType, complex content |
Defined: |
<xs:element maxOccurs="unbounded" minOccurs="0" ref="catgry"/> |
Type: |
catgryGrpType, complex content |
Defined: |
<xs:element maxOccurs="unbounded" minOccurs="0" ref="catgryGrp"/> |
Type: |
catLevelType, empty content |
Defined: |
<xs:element maxOccurs="unbounded" minOccurs="0" ref="catLevel"/> |
Type: |
simpleTextType, mixed content |
Defined: |
<xs:element maxOccurs="unbounded" minOccurs="0" ref="codInstr"/> |
Type: |
conceptType, mixed content |
Defined: |
<xs:element maxOccurs="unbounded" minOccurs="0" ref="concept"/> |
Type: |
derivationType, complex content |
Defined: |
<xs:element minOccurs="0" ref="derivation"/> |
Type: |
embargoType, mixed content |
Defined: |
<xs:element maxOccurs="unbounded" minOccurs="0" ref="embargo"/> |
Type: |
geoMapType, empty content |
Defined: |
<xs:element maxOccurs="unbounded" minOccurs="0" ref="geoMap"/> |
Type: |
simpleTextType, mixed content |
Defined: |
<xs:element maxOccurs="unbounded" minOccurs="0" ref="imputation"/> |
Type: |
invalrngType, complex content |
Defined: |
<xs:element maxOccurs="unbounded" minOccurs="0" ref="invalrng"/> |
Type: |
locationType, empty content |
Defined: |
<xs:element maxOccurs="unbounded" minOccurs="0" ref="location"/> |
Type: |
notesType, mixed content |
Defined: |
<xs:element maxOccurs="unbounded" minOccurs="0" ref="notes"/> |
Type: |
simpleTextType, mixed content |
Defined: |
<xs:element maxOccurs="unbounded" minOccurs="0" ref="respUnit"/> |
Type: |
simpleTextAndDateType, mixed content |
Defined: |
<xs:element maxOccurs="unbounded" minOccurs="0" ref="security"/> |
Type: |
stdCatgryType, mixed content |
Defined: |
<xs:element maxOccurs="unbounded" minOccurs="0" ref="stdCatgry"/> |
Type: |
sumStatType, mixed content |
Defined: |
<xs:element maxOccurs="unbounded" minOccurs="0" ref="sumStat"/> |
Type: |
simpleTextType, mixed content |
Defined: |
<xs:element maxOccurs="unbounded" minOccurs="0" ref="TotlResp"/> |
Type: |
simpleTextType, mixed content |
Defined: |
<xs:element maxOccurs="unbounded" minOccurs="0" ref="undocCod"/> |
Type: |
universeType, mixed content |
Defined: |
<xs:element maxOccurs="unbounded" minOccurs="0" ref="universe"/> |
Type: |
valrngType, complex content |
Defined: |
<xs:element maxOccurs="unbounded" minOccurs="0" ref="valrng"/> |
Type: |
varFormatType, mixed content |
Defined: |
<xs:element minOccurs="0" ref="varFormat"/> |
Type: |
verStmtType, complex content |
Defined: |
<xs:element maxOccurs="unbounded" minOccurs="0" ref="verStmt"/> |
XML schema documentation generated with DocFlex/XML 1.8.7 using DocFlex/XML XSDDoc 2.7.0 template set |