The current directory of examples isn't easy to navigate. The examples are essentially on distinguished by the topic of the data, whereas what's interesting are the features that they present.
We might provide an overview (e.g. "examples/readme.md" or "doc/readme.md") to explain why each example is interesting. This might take the form of an FAQ "How do I namespace codes within a codelist?".
Add example(s) for why components:columns isn't 1:1
Many of the people encountering the library have wondered if we couldn't consolidate columns and components. It might be worth providing some examples to demonstrate why these are separate:
You can use components in the cube-pipeline that you didn't create in the components-pipeline (e.g. a external dimension property like sdmx-dim:refPeriod)
You can have multiple configurations for a given component (so you can create different value-templates for the same property-template)
You can derive a property-template from multiple columns in the input
Add example of name-spacing codes
The ONS column configurations include templates like domain.com/def/concept/age/{notation} while the notations look like nisra/4 or nrs/3-or-4 allowing name-spacing within a single codelist without needing multiple column definitions etc).
Add diagram to regional-trade example
The colour-coded spreadsheet from the regional-trade example seems to have helped some people to get their heads around this. Perhaps we should include a diagram showing a few tables (i.e. as images, not just a spreadsheet)?
Add overview for examples
The current directory of examples isn't easy to navigate. The examples are essentially on distinguished by the topic of the data, whereas what's interesting are the features that they present.
We might provide an overview (e.g. "examples/readme.md" or "doc/readme.md") to explain why each example is interesting. This might take the form of an FAQ "How do I namespace codes within a codelist?".
Add example(s) for why components:columns isn't 1:1
Many of the people encountering the library have wondered if we couldn't consolidate columns and components. It might be worth providing some examples to demonstrate why these are separate:
sdmx-dim:refPeriod)Add example of name-spacing codes
The ONS column configurations include templates like
domain.com/def/concept/age/{notation}while the notations look likenisra/4ornrs/3-or-4allowing name-spacing within a single codelist without needing multiple column definitions etc).Add diagram to regional-trade example
The colour-coded spreadsheet from the regional-trade example seems to have helped some people to get their heads around this. Perhaps we should include a diagram showing a few tables (i.e. as images, not just a spreadsheet)?