New TableDoc class providing a table interface for data documentation

[jesper-friis]

Description

Added the TableDoc class providing a table interface for data documentation.

This PR builds on top of PR #272. Merge that one first.

Type of change

• Bug fix and code cleanup
• New feature
• Documentation update
• Testing

Checklist for the reviewer

This checklist should be used as a help for the reviewer.

• Is the change limited to one issue?
• Does this PR close the issue?
• Is the code easy to read and understand?
• Do all new feature have an accompanying new test?
• Has the documentation been updated as necessary?
• Is the code properly tested?

[codecov]

Codecov Report

Attention: Patch coverage is 90.00000% with 6 lines in your changes missing coverage. Please review.

Project coverage is 78.46%. Comparing base (f040624) to head (33600be).
Report is 1 commits behind head on master.

Files with missing lines	Patch %	Lines
tripper/dataset/dataset.py	80.64%	6 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #273      +/-   ##
==========================================
+ Coverage   78.21%   78.46%   +0.25%     
==========================================
  Files          20       21       +1     
  Lines        2153     2206      +53     
==========================================
+ Hits         1684     1731      +47     
- Misses        469      475       +6     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[torhaugl]

Suggested some small documentation changes.

This PR adds a TableDoc class and addnested function with tests.
One issue is that we cannot add multiple of the same nested data (two distribution.downloadURL for instance). Can you add a warning for this in addnested?

Something like if d = {"a" : {"b" : 1}}, then a warning/error is issued

d = {"a" : {"b" : 1}}
addnested(d, "a.b", 2)
### WARNING/ERROR, a.b already exists.

[torhaugl]

Suggested change

	# context={
	# "ds": "http:/example.com/datasets#",
	# },

[jesper-friis]

I would like to keep this comment, since the intention is to uncomment it when we have a fully working implementation of the context keyword argument. Added a comment to clarify this

[jesper-friis]

One issue is that we cannot add multiple of the same nested data (two distribution.downloadURL for instance). Can you add a warning for this in addnested?

Something like if d = {"a" : {"b" : 1}}, then a warning/error is issued

d = {"a" : {"b" : 1}}
addnested(d, "a.b", 2)
### WARNING/ERROR, a.b already exists.

The result of the above is

{'a': {'b': [1, 2]}}

with the current implementation of addnested(). The purpose is to allow adding multiple of the same (nested) data. It is mentioned in the docstring for add( ), which addnested() refer to. Should it be better documented?

addnested() is more intended as a utility function rather than a main part of the public API.