Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated dataset module #272

Merged
merged 4 commits into from
Dec 16, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Added blank lines before lists in docstrings as suggested by flb
jesper-friis committed Dec 16, 2024
commit 61a8ba8b47bc0d762f2e1c562ecaaf3e5fa0421f
5 changes: 5 additions & 0 deletions tripper/dataset/dataset.py
Original file line number Diff line number Diff line change
@@ -6,18 +6,22 @@
meaning of the keywords in this dict are defined by a [JSON-LD context].

High-level function for populating the triplestore from YAML documentation:

- `save_datadoc()`: Save documentation from YAML file to the triplestore.

Functions for searching the triplestore:

- `search_iris()`: Get IRIs of matching entries in the triplestore.

Functions for working with the dict-representation:

- `read_datadoc()`: Read documentation from YAML file and return it as dict.
- `save_dict()`: Save dict documentation to the triplestore.
- `load_dict()`: Load dict documentation from the triplestore.
- `as_jsonld()`: Return the dict as JSON-LD (represented as a Python dict)

Functions for interaction with OTEAPI:

- `get_partial_pipeline()`: Returns a OTELib partial pipeline.

---
@@ -127,6 +131,7 @@ def save_dict(
Notes:
The keys in `dct` and `kwargs` may be either properties defined in the
[JSON-LD context] or one of the following special keywords:

- "@id": Dataset IRI. Must always be given.
- "@type": IRI of the ontology class for this type of data.
For datasets, it is typically used to refer to a specific subclass