Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Current and Past Participants List

Prototype Timeline


Prototype - Deliverables

...

Last revised: January 15, 2018

...

Functional Views

Library Packages

Use Cases

Deliverables

  • Agent Registry View
  • Data Dictionary View
  • Instrument View
  • Simple Codebook View
  • Statistical Classification View
  • Structured Geography View
  • [Complex data description
]
  • [Data processing]
  • Agents
  • Conceptual
  • Data Capture
  • Discovery
  • Format Description
  • Geographic Classification
  • Identification
  • Logical Data Description
  • Methodologies
  • Representations
  • Sampling Methodology
  • Simple Codebook
  • Simple Methodology Overview
  • Study Related
  • Utility
  • Workflows






  • Codebook
  • Data capture - simple questionnaire content and flow, non-question based data (register data, simple protocols, internet, etc.)
  • Data description - various formats
  • Data processing
  • Data transformations
  • Archive a study (repository)
  • Simple study description (catalog)
  • Statistical classifications 
  • Geographic classifications
  • The Model – although this is at the heart of the documentation, we would also like to have a processable version of the model in XMI (an XML format for describing models). This will be in canonical XMI, a flavor of that format supported across many UML tools. There will only be an XML file for the entire model being published – there is no sub-set for each View, etc. as for some other deliverables.

  • XML Schemas – Descriptions of both the full class library and subset XML Schemas for each identified Functional View (groupings of objects to support specific functions).

  • RDF-S/OWL Vocabulary for RDF –There will be a vocabulary for the entire library, and a set of Functional View-level vocabularies. These would be expressed using OWL.

  • Documentation – Documentation would be organized such that each Functional View would be documented in an abbreviated form of the overall documentation, which would cover the entire library. There will be both high-level documentation, explaining the whole of the specification and its supporting parts, and detail-level documentation covering each class, property, etc.
    Documentation will be presented in the following areas:

    • Documentation of the model is provided in two formats: as a clickable HTML presentation, and as a PDF document.
    • Examples (including those specific to each binding) will be organized by Functional Views to make the model as approachable as possible for implementers. The examples will reflect the uses cases that can be supported by each Functional View.
    • Mappings will provide object- and property-level mappings from the Prototype to DDI Codebook (v. 2.5), DDI Lifecycle (v. 3.2), and GSIM v. 1.1.

...