Swirrl / table2qb

A generic pipeline for converting tabular data into rdf data cubes
Eclipse Public License 1.0
13 stars 4 forks source link

Update documentation. #95

Closed lkitching closed 5 years ago

lkitching commented 5 years ago

Issues #62, #83, 84 - Update the table2qb documentation to describe the structure of generated URIs as well as the relationship between the pipelines.

Move the usage documentation into its own page and update the employment example to follow a similar structure.

Robsteranium commented 5 years ago

This is excellent @lkitching. Explaining each pipeline in turn with examples and specifics on how the URIs are derived makes it much clearer.

I've taken the liberty of making some small tweaks - the patch should be self-explanatory.

I think there are some other avenues for extension:

Reading this I'm also beginning to wonder about making some changes to the code:

lkitching commented 5 years ago

@Robsteranium - We already valdiate the name field doesn't contain hyphens. Ideally we could use the validation in csv2rdf to check it's a valid variable name within a URI template. I'm wondering if having our own URI template library might be useful. I've created an issue for validating generated cubes. Agree re re-naming input-csv, I've started referring to it as observations-csv in parts of the code but renaming the pipeline parameter also makes sense.

Robsteranium commented 5 years ago

The outstanding points have gone into #97, #98, #99 and #100.