element <varGrp> (global)
Namespace:
Type:
Content:
complex, 18 attributes, 6 elements
Defined:
globally in codebook.xsd; see XML source
Used:
XML Representation Summary
<varGrp
   
 = 
xs:ID
 = 
xs:NMTOKEN
 = 
xs:language
 = 
("archive" | "producer") : "producer"
 = 
xs:string
 = 
(xs:dateTime | xs:date | xs:gYearMonth | xs:gYear)
 = 
xs:anyURI
 = 
xs:anyURI
 = 
("section" | "multipleResp" | "grid" | "display" | "repetition" | "subject" | "version" | "iteration" | "analysis" | "pragmatic" | "record" | "file" | "randomized" | "other") : "other"
 = 
xs:NMTOKEN
 = 
xs:IDREFS
 = 
xs:IDREFS
 = 
xs:string
 = 
xs:IDREFS
 = 
xs:IDREFS
 = 
xs:IDREFS
 = 
xs:IDREFS
 = 
xs:string
    >
   
Content: 
labl*, txt*, concept*, defntn*, universe*, notes*
</varGrp>
Content model elements (6):
concept, defntn, labl, notes, txt, universe
Included in content model of elements (1):
dataDscr
Known Usage Locations
Annotation

Variable Group

Description

A group of variables that may share a common subject, arise from the interpretation of a single question, or are linked by some other factor.

Variable groups are created this way in order to permit variables to belong to multiple groups, including multiple subject groups such as a group of variables on sex and income, or to a subject and a multiple response group, without causing overlapping groups. Variables that are linked by use of the same question need not be identified by a Variable Group element because they are linked by a common unique question identifier in the Variable element. Note that as a result of the strict sequencing required by XML, all Variable Groups must be marked up before the Variable element is opened. That is, the mark-up author cannot mark up a Variable Group, then mark up its constituent variables, then mark up another Variable Group.

The "type" attribute refers to the general type of grouping of the variables, e.g., subject, multiple response. Use the value of "other" if the value is to come from an external controlled vocabulary, and place the term into the otherType attribute.

The "otherType" attribute is used when the "type" 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.

Specific variable groups, included within the "type" attribute, are:

Section: Questions which derive from the same section of the questionnaire, e.g., all variables located in Section C.

Multiple response: Questions where the respondent has the opportunity to select more than one answer from a variety of choices, e.g., what newspapers have you read in the past month (with the respondent able to select up to five choices).

Grid: Sub-questions of an introductory or main question but which do not constitute a multiple response group, e.g., I am going to read you some events in the news lately and you tell me for each one whether you are very interested in the event, fairly interested in the fact, or not interested in the event.

Display: Questions which appear on the same interview screen (CAI) together or are presented to the interviewer or respondent as a group.

Repetition: The same variable (or group of variables) which are repeated for different groups of respondents or for the same respondent at a different time.

Subject: Questions which address a common topic or subject, e.g., income, poverty, children.

Version: Variables, often appearing in pairs, which represent different aspects of the same question, e.g., pairs of variables (or groups) which are adjusted/unadjusted for inflation or season or whatever, pairs of variables with/without missing data imputed, and versions of the same basic question.

Iteration: Questions that appear in different sections of the data file measuring a common subject in different ways, e.g., a set of variables which report the progression of respondent income over the life course.

Analysis: Variables combined into the same index, e.g., the components of a calculation, such as the numerator and the denominator of an economic statistic.

Pragmatic: A variable group without shared properties.

Record: Variable from a single record in a hierarchical file.

File: Variable from a single file in a multifile study.

Randomized: Variables generated by CAI surveys produced by one or more random number variables together with a response variable, e.g, random variable X which could equal 1 or 2 (at random) which in turn would control whether Q.23 is worded "men" or "women", e.g., would you favor helping [men/women] laid off from a factory obtain training for a new job?

Other: Variables which do not fit easily into any of the categories listed above, e.g., a group of variables whose documentation is in another language.

The "var" attribute is used to reference all the constituent variable IDs in the group.

The "varGrp" attribute is used to reference all the subsidiary variable groups which nest underneath the current varGrp. This allows for encoding of a hierarchical structure of variable groups.

The attribute "name" provides a name, or short label, for the group.

The "sdatrefs" are summary data description references that record the ID values of all elements within the summary data description section of the Study Description that might apply to the group. 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 group. 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 codeBook/stdyDscr/othrStdyMat or codeBook/otherMat that pertain to this variable group.

The "access" attribute records the ID values of all elements in codeBook/stdyDscr/dataAccs of the document that describe access conditions for this variable group.

The attribute "nCube" was included in 2.0 and subsequent versions in ERROR. DO NOT USE THIS ATTRIBUTE. It is retained only for purposes of backward-compatibility.

XML Source (w/o annotations (1); see within schema source)
<xs:element name="varGrp" type="varGrpType"/>
Attribute Detail (all declarations; 18/18)
access
Type:
xs:IDREFS, predefined
Use:
optional
Defined:
locally within varGrpType complexType
XML Source (see within schema source)
<xs:attribute name="access" type="xs:IDREFS"/>

ddiCodebookUrn
Type:
xs:anyURI, predefined
Use:
optional
Defined:
locally within GLOBALS attributeGroup
Used to capture the DDI-Codebook type URN for the element. This is used to assign a DDI-Codebook specific URN to the element, according the format prescribed by the DDI-Codebook standard.
XML Source (w/o annotations (1); see within schema source)
<xs:attribute name="ddiCodebookUrn" type="xs:anyURI" use="optional"/>

ddiLifecycleUrn
Type:
xs:anyURI, predefined
Use:
optional
Defined:
locally within GLOBALS attributeGroup
Used to capture the DDI-Lifecycle type URN for the element. This may be captured during translation from DDI-Lifecycle to DDI-Codebook structure or in preparation for transferring to a DDI-Lifecycle structure.
XML Source (w/o annotations (1); see within schema source)
<xs:attribute name="ddiLifecycleUrn" type="xs:anyURI" use="optional"/>

elementVersion
Type:
xs:string, predefined
Use:
optional
Defined:
locally within GLOBALS attributeGroup
Captures version of the element
XML Source (w/o annotations (1); see within schema source)
<xs:attribute name="elementVersion" type="xs:string" use="optional"/>

elementVersionDate
Type:
Use:
optional
Defined:
locally within GLOBALS attributeGroup
Indicates version date for the element. Use YYYY-MM-DD, YYYY-MM, or YYYY formats.
Attribute Value
xs:dateTime | xs:date | xs:gYearMonth | xs:gYear
XML Source (w/o annotations (1); see within schema source)
<xs:attribute name="elementVersionDate" type="dateSimpleType" use="optional"/>

ID
Type:
xs:ID, predefined
Use:
optional
Defined:
locally within GLOBALS attributeGroup
XML Source (see within schema source)
<xs:attribute name="ID" type="xs:ID" use="optional"/>

methrefs
Type:
xs:IDREFS, predefined
Use:
optional
Defined:
locally within varGrpType complexType
XML Source (see within schema source)
<xs:attribute name="methrefs" type="xs:IDREFS"/>

name
Type:
xs:string, predefined
Use:
optional
Defined:
locally within varGrpType complexType
XML Source (see within schema source)
<xs:attribute name="name" type="xs:string"/>

nCube
Type:
xs:string, predefined
Use:
optional
Defined:
locally within varGrpType complexType
XML Source (see within schema source)
<xs:attribute name="nCube" type="xs:string"/>

otherType
Type:
xs:NMTOKEN, predefined
Use:
optional
Defined:
locally within varGrpType complexType
XML Source (see within schema source)
<xs:attribute name="otherType" type="xs:NMTOKEN" use="optional"/>

pubrefs
Type:
xs:IDREFS, predefined
Use:
optional
Defined:
locally within varGrpType complexType
XML Source (see within schema source)
<xs:attribute name="pubrefs" type="xs:IDREFS"/>

sdatrefs
Type:
xs:IDREFS, predefined
Use:
optional
Defined:
locally within varGrpType complexType
XML Source (see within schema source)
<xs:attribute name="sdatrefs" type="xs:IDREFS"/>

source
Type:
anonymous simpleType (restriction of xs:NMTOKEN)
Use:
optional
Defined:
locally within GLOBALS attributeGroup
Attribute Value
enumeration of xs:NMTOKEN
Enumeration:
"archive", "producer"
Default:
"producer"
Anonymous simpleType
Type Derivation Tree
xs:NMTOKEN (restriction)
  simpleType
Derivation:
restriction of xs:NMTOKEN
Facets:
enumeration:
"archive", "producer"
XML Source (see within schema source)
<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
Type:
anonymous simpleType (restriction of xs:NMTOKEN)
Use:
optional
Defined:
locally within varGrpType complexType
Attribute Value
enumeration of xs:NMTOKEN
Enumeration:
"section", "multipleResp", "grid", "display", "repetition", "subject", "version", "iteration", "analysis", "pragmatic", "record", "file", "randomized", "other"
Default:
"other"
Anonymous simpleType
Type Derivation Tree
xs:NMTOKEN (restriction)
  simpleType
Derivation:
restriction of xs:NMTOKEN
Facets:
enumeration:
"section", "multipleResp", "grid", "display", "repetition", "subject", "version", "iteration", "analysis", "pragmatic", "record", "file", "randomized", "other"
XML Source (see within schema source)
<xs:attribute default="other" name="type">
<xs:simpleType>
<xs:restriction base="xs:NMTOKEN">
<xs:enumeration value="section"/>
<xs:enumeration value="multipleResp"/>
<xs:enumeration value="grid"/>
<xs:enumeration value="display"/>
<xs:enumeration value="repetition"/>
<xs:enumeration value="subject"/>
<xs:enumeration value="version"/>
<xs:enumeration value="iteration"/>
<xs:enumeration value="analysis"/>
<xs:enumeration value="pragmatic"/>
<xs:enumeration value="record"/>
<xs:enumeration value="file"/>
<xs:enumeration value="randomized"/>
<xs:enumeration value="other"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>

var
Type:
xs:IDREFS, predefined
Use:
optional
Defined:
locally within varGrpType complexType
XML Source (see within schema source)
<xs:attribute name="var" type="xs:IDREFS"/>

varGrp
Type:
xs:IDREFS, predefined
Use:
optional
Defined:
locally within varGrpType complexType
XML Source (see within schema source)
<xs:attribute name="varGrp" type="xs:IDREFS"/>

xml-lang
Type:
xs:NMTOKEN, predefined
Use:
optional
Defined:
locally within GLOBALS attributeGroup
DO NOT USE THIS ATTRIBUTE. Its inclusion is an error that was persisted to retain backward compatibility. If this attribute has been used, transfer the content to xml:lang.
XML Source (w/o annotations (1); see within schema source)
<xs:attribute name="xml-lang" type="xs:NMTOKEN" use="optional"/>

xml:lang
Type:
xs:language, predefined
Use:
optional
Defined:
by reference within GLOBALS attributeGroup
XML Source (see within schema source)
<xs:attribute ref="xml:lang" use="optional"/>
Content Element Detail (all declarations; 6/6)
concept
Type:
conceptType, mixed content
Defined:
by reference within varGrpType complexType
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="concept"/>

defntn
Type:
simpleTextType, mixed content
Defined:
by reference within varGrpType complexType
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="defntn"/>

labl
Type:
lablType, mixed content
Defined:
by reference within varGrpType complexType
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="labl"/>

notes
Type:
notesType, mixed content
Defined:
by reference within varGrpType complexType
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="notes"/>

txt
Type:
txtType, mixed content
Defined:
by reference within varGrpType complexType
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="txt"/>

universe
Type:
universeType, mixed content
Defined:
by reference within varGrpType complexType
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="universe"/>

XML schema documentation generated with DocFlex/XML 1.8.7 using DocFlex/XML XSDDoc 2.7.0 template set