search

common-workflow-language / user_guide

The CWL v1.0 - v1.2 user guide
http://www.commonwl.org/user_guide/
Other
41 stars 67 forks source link

Clarification needed for the acronym "URI" in the context of RRID #409

Open zoe-translates opened 1 year ago

zoe-translates commented 1 year ago

https://github.com/common-workflow-language/user_guide/blob/b6c2f66a69f2eb63ba37b9a012eaa73743320701/src/topics/specifying-software-requirements.md?plain=1#L29

Should this be uniform resource identifier? (Although I don't think the RRID has a formal URL scheme or URN namespace yet.)

mr-c commented 1 year ago

@zoe-translates That's correct. Really it needs to be any persistent identifier (PID) in the form of an URI/IRI, so we can take the RRID CURIE and express it as a full URI/IRI using a resolution service like identifiers.org.

So that's the full technical explanation; but that is overly complex for this section, I think.

I would happily review and clarification or simplification you would suggest!

zoe-translates commented 1 year ago

Based on my understanding of the SoftwarePackage in the specification, the specs field should only list full IRIs, rather than compact IDs -- is that correct? Am I correct in assuming that the correct "resolution" of a compact ID to IRI (here using the identifiers.org redirect) is something the user should do, in order to maximize the interoperability of the CWL file being written?

mr-c commented 1 year ago

Based on my understanding of the SoftwarePackage in the specification, the specs field should only list full IRIs, rather than compact IDs -- is that correct?

That is correct; full URI/IRIs only.

Am I correct in assuming that the correct "resolution" of a compact ID to IRI (here using the identifiers.org redirect) is something the user should do, in order to maximize the interoperability of the CWL file being written?

Yes