smnorris/bcdata

data description

Closed this issue · 1 comments

smnorris commented

bcdata info gets the table description from a resource's object_table_comments, but this can be uninformative:

$ bcdata info bec-map --indent 2| head
{
  "name": "WHSE_FOREST_VEGETATION.BEC_BIOGEOCLIMATIC_POLY",
  "count": 15666,
  "description": null,

Consider using "purpose" and/or "notes" instead, or augmenting the description with these two keys.

smnorris commented

R package uses the "notes" as description - and it seems to be consistent for all resources associated with a given package. https://bcgov.github.io/bcdata/articles/service_documentation.html