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

Not all Software Metadata Requirements are relevant for the cultural heritage domain #140

Open
ddeboer opened this issue Jan 26, 2023 · 1 comment
Assignees
Labels
FAIR Tool Discovery FAIR Tool Discovery

Comments

@ddeboer
Copy link
Contributor

ddeboer commented Jan 26, 2023

@proycon Some Software Metadata Requirements seem to be geared more towards scientific than cultural heritage tools (such as NDE is developing). For example when validating one of our tools, we get:

2. Info: Reference publications *SHOULD* be expressed (This is missing in the metadata)
3. Info: The funder *SHOULD* be acknowledged (This is missing in the metadata)
4. Info: A research domain *SHOULD* be expressed as a category using the NWO Research Fields vocabulary (This is missing in the metadata)

While I don’t know the details of how you calculate the star rating, these three requirements don’t really make sense for it. Are SHOULDs completely optional or still part of the rating? (Sorry if you already documented this somewhere and I missed it.)

And should we amend requirement 17 to read ‘if applicable’?

@proycon
Copy link
Member

proycon commented Jan 26, 2023

While I don’t know the details of how you calculate the star rating, these
three requirements don’t really make sense for it. Are SHOULDs completely
optional or still part of the rating? (Sorry if you already documented this
somewhere and I missed it.)

The computatation is debatable. At least all MUSTs must be satisfied (they
produce a violation), for SHOULDs it is a mixed bag, some produce warnings
(which should be resolved if you want an official validation 'pass') and some
produce info notices like the ones you got. MAYs always produce info notices.
For a successful validation you need to resolve the Violations and Warnings
only. The info notices provide hints to improve it but if you have good reason not to
provide something, then that is perfectly fine and you can still attain a 4/5 rating.
(5 really means perfection, no info notices, and is rare, and not something to obsess about either)

  1. Info: The funder SHOULD be acknowledged (This is missing in the metadata)

Doesn't NDE have a funder that can be acknowledged? If not, then just leave it out yes.

  1. Info: Reference publications SHOULD be expressed (This is missing in the metadata)

Yep, this happens often, many tools don't have proper publications.

Perhaps we need to amend both these points with 'if any/applicable'.

And should we amend requirement 17 to read ‘if applicable’?

Yes, that might be best indeed.

proycon added a commit to CLARIAH/tool-discovery that referenced this issue Jan 26, 2023
proycon added a commit that referenced this issue Jan 26, 2023
@proycon proycon self-assigned this Jan 26, 2023
@proycon proycon added the FAIR Tool Discovery FAIR Tool Discovery label Jan 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FAIR Tool Discovery FAIR Tool Discovery
Projects
None yet
Development

No branches or pull requests

2 participants