Skip to content

Explore: data-dict.yaml as the canonical metadata source (roxygen, JSON-LD, README derived from it) #108

Description

@larnsce

Motivation

Once #105#107 land, washr would have two authoring surfaces: data-raw/dictionary.csv (canonical today) and data-dict.yaml (generated). Long term the pipeline could invert — authors edit data-dict.yaml (with the data-dict LSP/VS Code tooling) and washr derives everything from it:

  • setup_roxygen() reads YAML and emits richer @format blocks (units, allowed values, ranges)
  • generate_jsonld() maps YAML → schema.org variableMeasured (touches the Reconsider the dataspice metadata workflow: retire add_metadata() or fix its location and use? #87 dataspice reconsideration)
  • dictionary.csv / attributes.csv become generated compatibility exports
  • data-dict render / export-spec output embedded as a proper dictionary page on the pkgdown site
  • glossary: becomes the machine-readable home for WASH domain vocabulary (JMP ladder levels etc.)

Background: dev/research-data-dict-integration.md, section "Option C".

Why backlog, not a release

This is a breaking workflow change for every existing openwashdata package, and the spec is still v0.1.0. Decision inputs before this graduates to a release milestone:

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions