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

Regular expressions are difficult to use as a novice in entering values #187

Open
sierra-moxon opened this issue Sep 25, 2024 · 3 comments
Labels
beta-feedback Related to feedback received from beta testers bug Something isn't working v1-release 🚀 Features and bug fixes that must be included in the first public release (i.e. general release)

Comments

@sierra-moxon
Copy link
Member

Bug summary

In the env broad scale entry screen, when annotating a sample, the regular expression that I need to follow is very long and hard to examine, understand, and comply with from within the edit screen

Bug details

Maybe some more granular validation interaction reports would be helpful?

E.g. if I add a term like "ENVO:00000123", I get "Value does not match pattern" and a long paragraph of text about how to select a term from ENVO ("Description") and then "Guidance" is a Pattern that has a lot of special characters that even as a software dev I would paste into an IDE to help me remember.

Under Examples, I see [ENVO:01000033] - does this mean I need brackets around my entry? Or is ENVO:00000123 too long? Or is it not a valid term in the ontology? Or is it an invalid term in a smaller picklist? Where can I find that picklist in the app?

I tried a few things (as above), but I still got the error so I am not sure how to fill out this field.

Steps to reproduce

  1. Launch app
  2. make study
  3. make sample
  4. fill out env broad scale and try to find a valid value from ENVO.

Anything else?

No response

App version

No response

Device type

Apple

Operating system version

iOS 17.6.1

@mslarae13
Copy link

Env triad will probably NOT be completed in the field.
So maybe we don't have to worry about it for the app?

@pkalita-lbl
Copy link
Collaborator

I think there are a few interrelated things here:

  1. We probably should just not show the regex. As noted in the description, it's pretty confusing to people who even understand regular expressions let alone normal people.
  2. We probably should find another way to communicate the required pattern to the user. Maybe that's something more abstract like term name [term id] or number unit. This maybe could come from the slot's structured_pattern if it's available or maybe we just need a custom annotation to define them.

@pkalita-lbl
Copy link
Collaborator

See also: microbiomedata/submission-schema#227

@pkalita-lbl pkalita-lbl added the v1-release 🚀 Features and bug fixes that must be included in the first public release (i.e. general release) label Nov 4, 2024
@pkalita-lbl pkalita-lbl added the beta-feedback Related to feedback received from beta testers label Nov 12, 2024
@pkalita-lbl pkalita-lbl changed the title Descriptions of fields and examples of input are terrific! regular expressions are difficult to use as a novice in entering values. Regular expressions are difficult to use as a novice in entering values Nov 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beta-feedback Related to feedback received from beta testers bug Something isn't working v1-release 🚀 Features and bug fixes that must be included in the first public release (i.e. general release)
Projects
Status: Backlog
Development

No branches or pull requests

3 participants