FAIR Data Cookbook#

Welcome to the FAIR Data Cookbook! This collection of recipes provides practical, step-by-step guides for implementing the FAIR Data JSON Schema vocabularies in your data assets with minimal effort.

Each recipe addresses a specific taskβ€”from basic identification to advanced semantic mappingβ€”and includes working code examples you can copy and adapt immediately.


🟒 Tier 1: Essential Recipes (Start Here)#

Get started in minutes using simple, intuitive annotations for everyday datasets:

πŸ“Š Tier 1 Simple Dataset

Annotate a simple, single-table dataset with title, license, unit type, measurement units, and self-documenting codes.

Tier 1 Simple Dataset Example
πŸ”‘ Persistent Identifiers & PIDs

Document primary canonical identifiers ($id, $anchor), resolvable PIDs (DOIs, w3ids, DIDs), random GUIDs, and scoped secondary IDs.

Persistent Identifiers & Discovery (PIDs, DIDs, GUIDs & Scoped IDs)
🏷️ Coded Values & Enums

Learn how to evolve standard JSON Schema enum fields into self-documenting FAIR coded values mapped to human titles and web concepts.

Coded Values: From Enums to FAIR Domains
🌐 Multilingual Metadata (i18n)

Learn how to write multilingual titles, labels, descriptions, and coded values using BCP-47 language maps.

Multilingual Metadata & Internationalization (i18n)

πŸ”΅ Tier 2: Advanced & Extended Recipes (Optional Deep-Dive)#

For users who want to dig deeper into formal data stewardship, these advanced recipes explore deep provenance, population bounds, and complex data lineage:

πŸ“¦ Data Products & Tables

Learn how to annotate basic dataset schemas and describe tables and resources with minimal effort.

Data Products & Dataset Relationships
🌊 The Variable Cascade

Implement formal variable lineage (Instance -> Represented -> Conceptual) using internal and external schema references.

The Variable Model & Cascade Master Guide
πŸ›οΈ Hierarchical Data Products

Describe complex multi-table data products, hierarchical structures, and cross-dataset join relationships.

Hierarchical Metadata: The Census Case Study
πŸ—οΈ Extension Mechanisms

Explore the four core mechanisms used to extend JSON Schema: Annotations, Vocabularies, Dialects, and Refinements.

Extension Mechanisms

All Recipes#


[!TIP] Each recipe includes a β€œHow-to” section with actionable steps. Check out the examples/ folder in the source repository for complete JSON schema files.