Data Artifex DDI Toolkit

User Guide:

  • Installation
    • Requirements
    • Installation from PyPI
    • Development Installation
    • Dependencies
    • Development Dependencies
    • Verification
  • Quick Start Guide
    • DDI-Codebook
    • DDI-CDI & Assistant Framework
    • Conversion from DDI-Codebook
    • Specification Loader
    • Next Steps
  • Examples
    • DDI-Codebook Examples
      • Basic Metadata Extraction
    • DDI-CDI Assistant Framework
      • Creating a DataSet with Variables
      • Serialization to RDF
      • Automated Identification
    • Direct Model Usage
    • DDI-Codebook to DDI-CDI Mapping
    • Specification Loader
  • DDI-Codebook to DDI-CDI CDIF Mappings
    • Overview
    • General Approach
    • Variable-Level Mappings
      • DDI-Codebook Variable → DDI-CDI InstanceVariable
    • Value Domain Mappings
      • Substantive Value Domain (Non-Missing Categories)
        • Standard Mode (use_skos=False)
        • SKOS Mode (use_skos=True)
      • Sentinel Value Domain (Missing Categories)
        • Standard Mode (use_skos=False)
        • SKOS Mode (use_skos=True)
    • Category and Code Mappings
      • Standard Mode (use_skos=False)
      • SKOS Mode (use_skos=True)
    • Dataset and Structure Mappings
      • DDI-Codebook fileDscr → DDI-CDI DataSet
      • DDI-Codebook fileDscr → DDI-CDI LogicalRecord
      • DDI-Codebook → DDI-CDI DataStructure
      • Variable Positioning in DataStructure
    • Resource Organization
    • Identifier Strategy
      • UUID Generation
      • ID Suffix Patterns
      • Non-DDI Identifiers
    • Important Assumptions
    • Processing Order
    • SKOS vs Standard Mode Comparison
    • Method Signature
      • Parameters
      • Returns
    • Usage Example
      • Basic Conversion
      • Standard Mode Conversion
      • Converting to RDF Graph
      • Exploring Resources
    • Related Functions
      • codebook_to_cdif_graph()
      • ddi_cdi_resources_to_graph()
    • Version Information
    • References
    • See Also

API Reference:

  • DDI-Codebook Processing
    • Overview
    • Basic Usage
    • Accessing Study Metadata
    • Working with Variables
    • Working with Files
    • Error Handling
    • Implementation Notes
    • Performance Considerations
    • API Reference
  • DDI Cross Domain Integration (CDI)
    • Architecture
    • Key Features
    • Basic Usage
    • Working with Associations
    • Mapping from DDI-Codebook
    • Deprecated Modules
    • API Reference Notes
  • DDI-CDI Specification Module
    • Overview
    • Key Features
    • Basic Usage
    • API Reference
      • DdiCdiModel
        • DdiCdiModel
  • RDF Integration
    • Overview
    • The Definitive Model (v1.0.0)
    • Direct Model Usage
    • SHACL Validation
    • Legacy RDF Implementation

Development:

  • Contributing
    • Getting Started
    • Development Setup
    • Running Tests
    • Code Style
    • Documentation
    • Submitting Changes
    • Types of Contributions
    • Guidelines
  • Changelog
    • Version 0.1.0 (Current)
      • DDI-Codebook 2.6 Upgrade
      • Refactors
      • Features
      • Known Issues
      • Upcoming Features
    • Previous Versions
Data Artifex DDI Toolkit
  • Search

© Copyright 2024-2025, Pascal L.G.A. Heus.

Built with Sphinx using a theme provided by Read the Docs.