OpenConceptLab / ocl_issues

Issues for all OCL repos. NOTE: Install ZenHub Browser Extension and request access to the OCL Roadmap board to view all issues and to contribute
4 stars 2 forks source link

Expansion picker #1958

Open paulsonder opened 1 month ago

paulsonder commented 1 month ago

In v3, the context of the Repository is set using the Version picker.

Versions affect content of the entire Repository, whereas Expansions affect content such as Concepts, Mappings and Reference resolutions.

For that reason, I have proposed moving the Expansion picker to be in closer proximity to the content it affects...

Requirements

jamlung-ri commented 1 month ago

@paulsonder here are some ideas to get us started. @paynejd or others, please feel free to edit this comment to add more or corrected info:

  1. As a consumer, I want to see which expansion of this repo version is being displayed so that I have the appropriate context.
  2. As a consumer, I want to be able to view further details of this expansion, such as its metadata (e.g. creation date/time) and its parameters (e.g. "activeOnly=true).
  3. As a consumer, I want to see which other expansions are available for this repo version (along with their summaries) so that I can select the one most relevant to my use case.
  4. As a consumer, I want to select a different expansion so that I can see how the reference(s) evaluated under different conditions.
  5. As a consumer, I want to see the summary of an expansion so I can understand how it was generated and what the high-level results were (e.g. number of concepts and mappings).
paulsonder commented 4 weeks ago

Thank you @jamlung-ri, There's a design for the Expansion picker in the Design System file ready for review!

https://zpl.io/LL4qkgm

jamlung-ri commented 4 weeks ago

@paulsonder This is a good start! Leaving some initial feedback:

First, I think one more statistic would be helpful (in addition to the number of concepts and mappings for each expansion), which is number of Resolved Repo Versions. We include this in the Expansion Parameter list in V2 currently (see screenshot below).

V2 Parameter list and Resolved Repo Versions: image

I think the main thing that is missing from the design is the presence of Expansion Parameters. This doesn't need to be super prominent, but a user should be aware if non-default Expansion Parameters are applied, and which ones. I could imagine some indicator that "One or more parameters were applied to this expansion" with a way to view these in more detail. This might not be in the Expansion Picker itself, but perhaps at least a tooltip that previews a brief text-based list of parameters.

An example of a text list of parameters that might appear in a tooltip?

date: 2024-12-10, activeOnly: true, exclude-system: loinc.org

Examples of available (or upcoming) expansion parameters: image

paulsonder commented 4 weeks ago
Screenshot 2024-11-01 at 13 42 55

We could use the info icon to open a modal as per v2, for the time being? This could include more information too, like some of the meta in v2?

@jamlung-ri

jamlung-ri commented 4 weeks ago

@paulsonder Can the icon be something that indicates the number of non-default parameters being used? Ideally, I should be able to get a vague idea of the differences between these expansions without opening a modal for each one. I do still think that a more informative tooltip could help too. I could imagine mousing through this list of expansions and seeing a couple rows with 0 non-default parameters used, and some rows that appear to have more parameters, which I would want to get a glimpse at what parameters were specified.

This might be tough though, because it might be cramming too much into a simple design. But I would need some kind of clue as to which expansion is most likely the one that I actually care about, without doing a deep dive (i.e. modal window) for every individual row.

Thoughts?

paulsonder commented 3 weeks ago

Hey @jamlung-ri - what do you think of the latest iteration?

jamlung-ri commented 3 weeks ago

It looks good for me! And it looks like we're still using the approach where we click the info icon to see the parameters in a modal, which I think should help.