Review field_definitions

[peterdesmet]

inst/extdata/field_definitions.tsv is now used to add definitions, types, units, examples to datapackage.json when creating a Data Package with get_package().

I think it would be good to carefully review these:

Definitions

• Don't reference aspects of the ETN Data Portal.
• Start with Capital, end with period.
• Refer to other fields using backticks.
• Refer to literal values using "quoted backticks".

Type

• Make sure all have type
• Make sure types are correct (e.g. number vs integer)

Unit

• Add units where missing

Example

• Update with real life examples, e.g. take an examplar row from 2014_demer.

Curation

• Remove unused fields
• Order fields cf. table?

This work can be done in a spreadsheet if needed and then copied.

[PietrH]

There used to be a etn_fields vignette that gave an overview of ... fields within the etn database. It seems to me we could recreate this vignette based on this tsv!

Might come in useful don't you think?

[peterdesmet]

Yeah, this might be useful, though I don't know who the audience would be:

• Researchers that use the ETN Data Platform see the definitions in context
• Researchers that use ETN data can see the information in datapackage.json

[PietrH]

I was thinking users that want to see what fields are available in etn without running any function. Someone who is discovering etn via the R package.

But maybe that's unlikely at the moment?