Convenience functions to access and use terminologies

Open
#131 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
backend

Research direction

Start with the terminology class and the usage example in issue #74, then compare them with the existing object.get_terminology_equivalent() behavior. Define and implement the proposed fetch, equivalent, and lookup convenience entry points, including the URL or UUID identifier cases, and verify that they support the described section and property workflows.

Written by the indexing model from the issue text.

Description

terminology v1.4

Access and using terminologies (e.g., g-node terminologies) are cumbersome at the moment (cf. example in #74).

It would be nice to have convenience functions in the terminology class for this, e.g.:

import odml.terminology as term

# fetches the g-node terminology, alternatively a local uri or another external url can be stated
term.fetch_terminology("G-Node")

# to find a possible terminology equivalent for a given object (returns clone of terminology entry)
term.get_terminology_equivalent(object)  # object could be a section or a property object
# currently possible is only:
object.get_terminology_equivalent()

# to use a terminology as a building block for building a tree
sec_obj = odml.Section("Subject")

# case 1: I do not know exactly what terminology entry I want (e.g. for property)
new_sec = term.get_terminology(name="Age")  # fetches property in terminology with name age
sec_obj.append(new_sec[2])

# case 2: I know exactly what terminology entry I want (e.g. for section)
sec_obj = term.get_terminology(url="http://portal.g-node.org/odml/terminologies/v1.0/subject/subject.xml", children=False)

In v1.4 the url-identifier could be also replaced with the uuids.

Dominant language
Python
Stars
25
Forks
30
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from G-Node/python-odml

All issues in G-Node/python-odml

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.