Skip to content

Commit

Permalink
docs: remove "precision-based property control"
Browse files Browse the repository at this point in the history
Remove references to "precision-based property control" as it is not
yet implemented.

Originally, the plan was to allow users to control the precision of
results from `main.convert` through a "match type threshold"
parameter, which would reference the SSSOM to determine if a
property mapping met the criteria to be included in the returned
graph.
  • Loading branch information
clnsmth authored Jun 28, 2024
1 parent 504521d commit 955b895
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions docs/source/dev/design.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ Currently, most repositories have their own implementations, however, a shared i
Functional design requirements we considered in the development of this application:

* Convert any metadata standards to SOSO.
* Use metadata mappings that enable control over the degree of output accuracy.
* Test against a consistent set of criteria.
* Customizable to enable unique use cases.

Expand Down Expand Up @@ -59,7 +58,7 @@ Users typically define workflows that iterate over a series of metadata files. F
Metadata Mapping
----------------

We utilize the `Simple Standard for Sharing Ontological Mappings`_ (SSSOM) for semantic mapping SOSO to metadata standards. SSSOM provides a framework for expressing the match accuracy and other essential information to guide developer implementations.
We utilize the `Simple Standard for Sharing Ontological Mappings`_ (SSSOM) for semantic mapping SOSO to metadata standards. SSSOM provides a framework for expressing the match precision and other essential information to guide developer implementations.

We apply SSSOM following `SSSOM guidelines`_, with some nuanced additions tailored to our project's needs. One such addition is the inclusion of a `subject_category` column, which aids in grouping and improving the readability of highly nested `subject_id` values. Additionally, we've formatted `subject_id` values using an arbitrary hierarchical path-like expression, enhancing clarity for the reader in understanding which property is being referenced. Note, while this path is human-readable, it is not machine-actionable.

Expand Down

0 comments on commit 955b895

Please sign in to comment.