psychoinformatics-de/shacl-vue

Patch LinkML to Enhance `enum` rendering

Open

#116 opened on May 19, 2025

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Vue (4 forks)auto 404
good first issue

Repository metrics

Stars
 (2 stars)
PR merge metrics
 (PR metrics pending)

Description

Origin: https://hub.psychoinformatics.de/inm7/annotate.inm7.de-simplesubmit/issues/19

At present only the literal enum values are shown.

image

It would be good to have their description be available as a tooltip (or equivalent) too.

and:

This is a current limitation of the shaclgen.py code in LinkML, because its output for enum values (sh:in) only includes the literal values. Here's an excerpt from the exported SHACL:

        [ sh:description "Type of an organization." ;
            sh:group inm7si:OrganizationPropertyGroup ;
            sh:in ( "team" "group" "division" "institute" "researchcenter" "researchorganization" "faculty" "college" "university" "nonprofit" "business" ) ;
            sh:maxCount 1 ;
            sh:name "Type"^^xsd:string ;
            sh:order 3 ;
            sh:path inm7si:organization_type ],

So we'll have to create a patch first, if possible.

Contributor guide

Research direction
Investigate LinkML's shaclgen.py to find where enum values are output and modify it to include descriptions, e.g., as tooltips in the SHACL representation.
Tech stack
pythonvue
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonLinkML
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75