Sample Use Cases for the Data Dictionary View

Sample Use Cases for the Data. Dictionary View in DDI Views (DDI 4) Dan Gillman, Arofan Gregory, Larry Hoyle, Knut Wenzig 9/29/2020 NADDI 2017 Use Cases for the Data. Dictionary View in DDI Views 1

DDI Views - http: //lion. ddialliance. org/ DDIViews (DDI 4) has Functional Views, which are subsets of the whole model, typically many fewer classes All Functional Views are compatible 9/29/2020 NADDI 2017 Use Cases for the Data. Dictionary View in DDI Views 2

Data. Dictionary Functional View Focuses on physical file structure 9/29/2020 NADDI 2017 Use Cases for the Data. Dictionary View in DDI Views 3

Classes in the Data. Dictionary Functional View • • • • 9/29/2020 Access Attribute. Role Category. Set Code. Item Code. List Concept Coverage Data. Point Data. Record Data. Store Datum Funding. Information Identifier. Role • • • • Individual Instance. Variable. Mapping Level Logical. Record. Layout Machine Measure. Role Organization Physical. Layout. Ordered. Pair Population Record. Relation Rectangular. Layout Segment. By. Text Sentinel. Conceptual. Domain NADDI 2017 Use Cases for the Data. Dictionary View in DDI Views • • • • Sentinel. Value. Domain Spatial. Coverage Structure. Description Substantive. Conceptual. Domain Substantive. Value. Domain Temporal. Coverage Topical. Coverage Unit. Type Universe Value. And. Concept. Description Value. Mapping Viewpoint This view has 43 of the current 858 classes in Lion 4

DDI-Views Packages (Example: Format. Description) Packages are useful when looking at, or developing, the overall model. They are not namespaces. 9/29/2020 NADDI 2017 Use Cases for the Data. Dictionary View in DDI Views 5

DDI-Views Packages (Example: Format. Description Detail) UML model features: • • Inheritance Realization Properties Relationships • • 9/29/2020 NADDI 2017 Use Cases for the Data. Dictionary View in DDI Views aggregations plain 6

Describing a class in Lion – definition, notes, and examples http: //lion. ddialliance. org/ ddiobjects/valuemapping 9/29/2020 NADDI 2017 Use Cases for the Data. Dictionary View in DDI Views 7

Describing a class in Lion – properties 9/29/2020 NADDI 2017 Use Cases for the Data. Dictionary View in DDI Views 8

Describing a class in Lion – relationships 9/29/2020 NADDI 2017 Use Cases for the Data. Dictionary View in DDI Views 9

Dagstuhl Week 2 Sprint 2016 https: //ddi-alliance. atlassian. net/wiki/pages/viewpage. action? page. Id=39911463 Data Description working group Tested the Data. Description View Physical file layouts: • CSV Simple rectangular • Fixed Column rectangular • CSV Segmented • CSV Hierarchical • CSV Aggregate (ncube) We also looked at event history data and think it will be describable with these elements too see: https: //ddi- alliance. atlassian. net/wiki/display/DDI 4/Data+Description+View+Team 9/29/2020 NADDI 2017 Use Cases for the Data. Dictionary View in DDI Views 10

Event History Data • The event is the unit of observation • Examples • A person visits a doctor: datasets holds all persons' id, date of visit and type of doctor; each row is a doctor's visit of a person • A petrol station registers each car in case of refilling: dataset holds license plate number, date/time of refilling and amount of fuel • Additions to DDI needed for event data • Which variable holds temporal information, which variable holds id of object with multiple events (see Viewpoint) • A datatype of “pointer” or “reference”, the value of which is a DDI Instance. Variable or perhaps a Value. Mapping 9/29/2020 NADDI 2017 Use Cases for the Data. Dictionary View in DDI Views 11

Simple Rectangular CSV https: //ddi-alliance. atlassian. net/wiki/display/DDI 4/Data+Description+View+Team More details are available on the web in the report from the working group 9/29/2020 NADDI 2017 Use Cases for the Data. Dictionary View in DDI Views 12

Simple Rectangular CSV – Australian Election Survey The example uses a small representative set of variables See: http: //www. australianelectionstudy. org/about. html 9/29/2020 NADDI 2017 Use Cases for the Data. Dictionary View in DDI Views 13

Example DDI 4 XML 9/29/2020 NADDI 2017 Use Cases for the Data. Dictionary View in DDI Views 14

More XML 9/29/2020 NADDI 2017 Use Cases for the Data. Dictionary View in DDI Views 15

Variable Cascade in DDI http: //lion. ddialliance. org/package/conceptual The Instance. Variable can reference Represented. Variable and Conceptual. Variable It also inherits all properties and relationships from them. 9/29/2020 NADDI 2017 Use Cases for the Data. Dictionary View in DDI Views 16

Modeled to comply with GSIM http: //www 1. unece. org/stat/platform/display/GSIMclick/Instance+Variable http: //www 1. unece. org/stat/platform/display/GSIMclick/Represented+Variable 9/29/2020 NADDI 2017 Use Cases for the Data. Dictionary View in DDI Views 17

Logical and physical records – at the record level 9/29/2020 Logical Physical • Variables • Logical variable order • Logical. Record link • Physical variable order • Number physical records per logical • Encoding etc. • Record parameters (e. g. terminator) • Delimited? /delimiter, quote char … NADDI 2017 Use Cases for the Data. Dictionary View in DDI Views 18

Physical Records – at the variable level • Physical representation • Datatype, decimal separator, group separator … • Location • Starting position, ending position, length • Record number 9/29/2020 NADDI 2017 Use Cases for the Data. Dictionary View in DDI Views 19

Describing a CSV Instance. Variable Logical. Record. Layout Value. Mapping 9/29/2020 Rectangular. Layout Relationships NADDI 2017 Use Cases for the Data. Dictionary View in DDI Views Physical. Layout. Order Physical 20

Instance Variable - Properties And Relationships http: //lion. ddialliance. org/ddiobjects/instancevariable • • • 9/29/2020 Agency ID Version Name Display. Label Descriptive. Text ANNOTATION Unit. Of. Measurement Variable. Role Physical. Datatype Intended. Datatype • • • Substantive. Conceptual. Domain Substantive. Value. Domain Sentinel. Conceptual. Domain Sentinel. Value. Domain Concept Unit. Type Universe Population Conceptual. Variable Represented. Variable External. Material NADDI 2017 Use Cases for the Data. Dictionary View in DDI Views 21

Logical. Record. Layout - Properties and Relationships • • • Agency, Id, Version Annotation Type Name Purpose Instance. Variable View. Point Logical. Reord. Layout External. Material http: //lion. ddialliance. org/ddiobjects/logicalrecordlayout As a Collection the Logical. Record. Layout allows for ordering Instance. Variables within the Record. Viewpoints allow assigning roles to Instance. Variables – Identifiers, Measures, or Attributes. • Realizes Collection 9/29/2020 NADDI 2017 Use Cases for the Data. Dictionary View in DDI Views 22

Rectangular. Layout (Physical. Layout) - Properties and Relationships • • • Agency, ID, Version Annotation Is. Delimited Delimiter Is. Fixed. Width Escape. Character Line. Terminator Quote. Character Comment. Prefix Encoding Header 9/29/2020 • • • Header. Row. Count Skip. Bank. Rows Skip. Data. Columns Skip. Initial. Space Skip. Rows Trim Null. Sequence Header. Is. Case. Sensitive Array. Base Treat. Consecutive. Delimiters. A s. One NADDI 2017 Use Cases for the Data. Dictionary View in DDI Views • • • http: //lion. ddialliance. org/ddiobjects/physicallayout Overview Table. Direction Text. Direction Type Name Purpose External. Material Value. Mapping Logical. Record. Layout Realizes Collection 23

Value. Mapping - Properties and Relationships • • • 9/29/2020 Agency, Id, Version Physical. Datatype Default. Decimal. Separator Default. Digital. Group. Separator Number. Pattern Default. Value Null. Sequence Format Length Minimum. Length Maximum. Length • • http: //lion. ddialliance. org/ddiobjects/valuemapping Scale Decimal. Positions Required External. Material • Instance. Variable • Physical. Segment. Location • (e. g. Start, end, length) NADDI 2017 Use Cases for the Data. Dictionary View in DDI Views 24

Physical. Layout. Order - Properties and Relationships http: //lion. ddialliance. org/ddiobjects/valuemapping Order Criteria (alphabetical, numerical …) Semantics (before) Reflexivity (Anti-Reflexive – a variable is not before itself) Symmetry (Anti – A before B means B not before A) Transitivity( Transitive (if A before B and B before C then A before C) Physical. Layout it structures Physical. Layout. Ordered. Pairs 9/29/2020 NADDI 2017 Use Cases for the Data. Dictionary View in DDI Views 25

Physical. Layout. Orded. Pair - Properties and Relationships http: //lion. ddialliance. org/ddiobjects/valuemapping Source Instance. Variable Target Instance. Variable The source variable is “before” the target variable. The Physical. Layout. Order defined the semantic: “before” Example: divisnum before uniqueid before mode … 9/29/2020 NADDI 2017 Use Cases for the Data. Dictionary View in DDI Views 26

Typical CSV Rectangular. Layout in XML 9/29/2020 NADDI 2017 Use Cases for the Data. Dictionary View in DDI Views 27

Instance. Variable for variable “Divis. Num” in XML Actually an “External. Controlled. Vocabulary. Entry” 9/29/2020 Much more about the Value. Domain for Divis. Num could be described with Substantive. Value. Domain and Sentinel. Value. Domain NADDI 2017 Use Cases for the Data. Dictionary View in DDI Views 28

CSV Value. Mapping for variable “Divis. Num” in XML Also an “External. Controlled. Vocabulary. Entry” 9/29/2020 NADDI 2017 Use Cases for the Data. Dictionary View in DDI Views 29

Fixed Layout Value. Mapping for variable “Divis. Num” in XML 9/29/2020 NADDI 2017 Use Cases for the Data. Dictionary View in DDI Views 30

Viewpoint http: //lion. ddialliance. org/ddiobjects/viewpoint • Assigns one of three roles to variables: • Identifier • Measure • Attribute • Useful for • Aggregate data (ncubes) • Event data (Which variable holds temporal information, which variable holds id of object with multiple events) • Annotating variables (e. g. paradata) 9/29/2020 NADDI 2017 Use Cases for the Data. Dictionary View in DDI Views 31