VariableType

Package: 
Is Abstract: 
no
Is Pattern: 
no
Definition: 

Describes the structure of a Variable. This is the applied expression of a data item within a data set and maps to the GSIM InstanceVariable. In addition to the standard name, label, and description, includes a reference to a source parameter, represented variable, conceptual variable, universe, concept, question, source variable, and embargo information. It identifies the normal source of the data in the variable, the unit of analysis, whether the variable provides temporal or geographic information, or serves as a weight for other variables in the data, and provides a full description of its representation.

Property: 
NameCardinalityDatatypeDescription
name
0..n
Name of the variable
label
0..n
A display label for the Variable. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations.
description
0..1
A description of the content and purpose of the Variable. May be expressed in multiple languages and supports the use of structured content.
sourceUnit
0..1
The normal source of the information contained in the variable. In the case of a survey this may be a respondent, proxy, interviewer, or other source. In the case of administrative data the position of a field on a form e.g., "top of page", "item 3", "generated by data processor", etc. Supports the use of an external controlled vocabulary.
analysisUnit
0..1
The entity to which the data refer, for example, individuals, families or households, groups, institutions/organizations, administrative units, etc. Supports the use of an external controlled vocabulary.
isTemporal
0..1
Set to "true" if the variable relays time-related information (date, time, season, relative time, etc.).
isGeographic
0..1
Set to "true" if the variable relays geographic information, i.e., geographic code, area name, relative location, etc.
isWeight
0..1
Set to "true" if the variable is used a weight when analyzing data within the data set.
Relationship: 
NameTarget ObjectDescriptionSource cardinalityTarget cardinalityRelationship type
sourceVariableReference
Reference to variable(s) used as a basis for recoding, derivation, or other means of calculating the data for this variable. This reference is intended to provide basic information on the source variable structure including value representation, measurement unit, etc. Note that if a variable is used by reference within multiple VariableSchemes you can identify its role within a specific VariableScheme by including that VariableScheme in the sourceContext attribute of the reference. Use ProcessingInstructionReference to provide additional information on the transformation of the source variable(s) into the data for this variable. If additional processing detail is required use the InParameter, OutParameter, and ParameterLinkage options in the GenerationInstruction and ProcessingInstructionReference.
0..n
0..n
Neither
conceptualVariableReference
Reference to the ConceptualVariable that describes the core of this variable. The ConceptualVariable provides linked Concept and Universe specifications. These may be constrained by specifications within the Variable description. TypeOfObject should be set to ConceptualVariable.
0..n
0..1
Neither
universeReference
Reference to the universe statement containing a description of the persons or other elements that this variable refers to, and to which any analytic results refer. If more than one universe is referenced the universe of the variable is the intersect of the referenced universes.
0..n
0..1
Neither
conceptReference
Reference to the concept measured by this variable.
0..n
0..1
Neither
embargoReference
Reference to any embargoes placed on the contents of this variable. Embargoes may limit access to the data and/or metadata to specific groups and/or for specified periods of time.
0..n
0..1
Neither
hasOutput
Has an output that can be bound to the input of a process within a process system or command code.
0..n
1..1
Aggregation
hasInput
Has an input that can be bound to the output of the variable.
0..n
1..1
Aggregation

Stage:

DDI 3.2: 
l:VariableType
Is extendable: 
GSIM: 
Instance Variable
Is property: 
0
RDF Mapping: 

Comments

larry's picture

This is still named as a "type". Does it duplicate "InstanceVariable"? There are no outParameter objects or sourceParameter objects for the coresponding properties. Is this an issue for the Process group?

- Discussed with Wendy at the London Sprint on 25-11-2014, need to review this object and clean up the historical properties. Should have one InParameter and one OutParameter as bindings.

- changed datatype on sourceParameterA and sourceParameterB to InParameter

This is essentially a copy of the 3.2 Variable. It is not used by any objects included in the Q1 release.