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

Give enumerations boilerplate definitions for now #836

Open
turbomam opened this issue Aug 13, 2024 · 5 comments
Open

Give enumerations boilerplate definitions for now #836

turbomam opened this issue Aug 13, 2024 · 5 comments
Assignees

Comments

@turbomam
Copy link
Member

part of

@turbomam turbomam self-assigned this Aug 13, 2024
@turbomam
Copy link
Member Author

turbomam commented Aug 13, 2024

Ideally the results form this command would be empty or extremely short

poetry run linkml-lint --format tsv src/mixs/schema/mixs.yaml

@turbomam
Copy link
Member Author

but like lots of other LinkML projects, we have PermissibleValues with "non-standard" names. So filter those out

poetry run linkml-lint --format tsv src/mixs/schema/mixs.yaml | grep -v 'Permissible value of Enum'

@turbomam
Copy link
Member Author

that's still pretty long, but mostly due to enums without descriptions. In the long run, we should write descriptions that describe the composition of the enums, rather than their use.

@turbomam turbomam linked a pull request Aug 13, 2024 that will close this issue
@turbomam
Copy link
Member Author

in PR's branch:

source  schema name     rule name       level   message
/Users/MAM/Documents/gitrepos/mixs/src/mixs/schema/mixs.yaml    mixs    recommended     warning Slot 'soil_conductivity' does not have recommended slot 'description'
/Users/MAM/Documents/gitrepos/mixs/src/mixs/schema/mixs.yaml    mixs    recommended     warning Slot 'soil_pH' does not have recommended slot 'description'
/Users/MAM/Documents/gitrepos/mixs/src/mixs/schema/mixs.yaml    mixs    recommended     warning Slot 'water_pH' does not have recommended slot 'description'
/Users/MAM/Documents/gitrepos/mixs/src/mixs/schema/mixs.yaml    mixs    recommended     warning Subset 'combination_classes' does not have recommended slot 'description'
/Users/MAM/Documents/gitrepos/mixs/src/mixs/schema/mixs.yaml    mixs    recommended     warning Subset 'sequencing' does not have recommended slot 'description'
/Users/MAM/Documents/gitrepos/mixs/src/mixs/schema/mixs.yaml    mixs    recommended     warning Subset 'environment' does not have recommended slot 'description'
/Users/MAM/Documents/gitrepos/mixs/src/mixs/schema/mixs.yaml    mixs    recommended     warning Subset 'nucleic acid sequence source' does not have recommended slot 'description'
/Users/MAM/Documents/gitrepos/mixs/src/mixs/schema/mixs.yaml    mixs    recommended     warning Subset 'investigation' does not have recommended slot 'description'
/Users/MAM/Documents/gitrepos/mixs/src/mixs/schema/mixs.yaml    mixs    standard_naming warning Slot has name 'HACCP_term'
/Users/MAM/Documents/gitrepos/mixs/src/mixs/schema/mixs.yaml    mixs    standard_naming warning Slot has name 'IFSAC_category'
/Users/MAM/Documents/gitrepos/mixs/src/mixs/schema/mixs.yaml    mixs    standard_naming warning Slot has name 'air_PM_concen'
/Users/MAM/Documents/gitrepos/mixs/src/mixs/schema/mixs.yaml    mixs    standard_naming warning Slot has name 'ferm_pH'
/Users/MAM/Documents/gitrepos/mixs/src/mixs/schema/mixs.yaml    mixs    standard_naming warning Slot has name 'microb_start_taxID'
/Users/MAM/Documents/gitrepos/mixs/src/mixs/schema/mixs.yaml    mixs    standard_naming warning Slot has name 'soil_pH'
/Users/MAM/Documents/gitrepos/mixs/src/mixs/schema/mixs.yaml    mixs    standard_naming warning Slot has name 'spikein_AMR'
/Users/MAM/Documents/gitrepos/mixs/src/mixs/schema/mixs.yaml    mixs    standard_naming warning Slot has name 'water_pH'

@turbomam
Copy link
Member Author

The linked PR does give the enums minimal descriptions, but unfortunately the diff of mixs.yaml is too large to view in the web interface, probably because I applied some reformatting.

We can look at a command line diff live in the next meeting and then make a go/no-go decision about the PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Progress
Development

Successfully merging a pull request may close this issue.

1 participant