Navigable DataDictionary
- Dominant language
- No language data
- Stars
- 52
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Description
Currently there is a dataDictionary.md produced by the [usdm-dictionary-generator](https://github.com/cdisc-org/usdm-dictionary-generator) and added as a deliverable to the [DDF-RA](https://github.com/cdisc-org/DDF-RA) via github action.
The md is not easily viewed in GH because of the large margins GH adds. There should be a better artifact generated with the following requirements:
- Easily viewed
- Types are linked to their classes
- Class Attributes are sorted better (id's first, relationships last, etc). They should retain the sort order of the xmi. Refer to: https://github.com/cdisc-org/DDF-RA/issues/193
- API should feed into the generator in order to distinguish ref/def relationship information
- Generation is part of the usdm-dictionary-generator
- Action is added to DDF-RA to copy the artifacts to DDF-RA
Two ideas:
- Linked md files; similar to, but simpler than the files produced by gen-erdiagram: https://github.com/cdisc-org/DDF-RA/blob/linkml/xmi-parser/md/index.md
- CSV or Excel similar to this file: https://github.com/cdisc-org/ddf-core-poc/blob/main/documents/USDM_Model.xlsx
Contributor guide
Assessment
This issue has not been assessed yet.