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

Add Codemeta terms #276

Merged
merged 13 commits into from
Aug 29, 2024
Merged

Add Codemeta terms #276

merged 13 commits into from
Aug 29, 2024

Conversation

stain
Copy link
Contributor

@stain stain commented Sep 29, 2023

See namespace considerations in #275 before merging.

Codemeta Namespace boldly assumed to be w3id-based rather than github.io
see codemeta/codemeta#216

Added Biochemas namespace comment, see
BioSchemas/specifications#653
@stain stain marked this pull request as draft September 29, 2023 01:54
@stain
Copy link
Contributor Author

stain commented Apr 25, 2024

Not sure if we should add this for 1.2 when we don't have a corresponding section explaining when to use embargoEndDate etc. Suggest to delay this for 2.0.

@stain
Copy link
Contributor Author

stain commented May 9, 2024

@dgarijo to double-check the PIDs

docs/1.2-DRAFT/metadata.md Outdated Show resolved Hide resolved
scripts/schema-context.py Outdated Show resolved Hide resolved
@dgarijo
Copy link
Contributor

dgarijo commented May 9, 2024

I added a few comments @stain. In Codemeta we resolved the resolution and content negotiation of w3id.org/codemeta, but at this time, the id is still https://codemeta.github.io/terms/. I followed with another comment to see if we can push forward changing the id of the vocabulary. That may lead to incompatibility changes, so I am not sure how reluctant will people be.

I suggest using for now the current Codemeta id, even if it's not machine readable

@stain
Copy link
Contributor Author

stain commented May 23, 2024

It's OK, better remain compatible for now and use codemeta.github.io namespace.

I can add the machine readable definitions to our core Profile Crate for 1.2-DRAFT, but we would need to add also human-readable text to explain also why these URLs are 404 Not Found.

@dgarijo
Copy link
Contributor

dgarijo commented May 23, 2024

As shown in codemeta/codemeta#360 my proposal is to move it to https://w3id.org/codemeta/terms/

It would be great if you drop a +1 to show your support to this change

@dgarijo
Copy link
Contributor

dgarijo commented May 23, 2024

Hopefully by June 20th we'll get it solved. But community standards are slow sometimes.

@stain stain changed the title Draft to add Codemeta terms Add Codemeta terms May 23, 2024
@stain stain marked this pull request as ready for review May 23, 2024 19:50
@stain
Copy link
Contributor Author

stain commented May 23, 2024

I've added machine readable version in https://github.com/ResearchObject/ro-crate/blob/codemeta/docs/1.2-DRAFT/ro-crate-metadata.json#L736 , which you are free to adapt/correct. Unsure about if domainIncludes should always be SoftwareApplication

Edit: Most of them say SoftwareSourceCode in https://github.com/codemeta/codemeta/blob/master/crosswalk.csv#L63

@dgarijo
Copy link
Contributor

dgarijo commented May 23, 2024

I will review when time allows. Thanks!

@stain
Copy link
Contributor Author

stain commented Jul 11, 2024

Ideally from https://www.researchobject.org/ro-crate/specification/1.2-DRAFT/appendix/jsonld.html#extending-ro-crate we should have a sameAs link for these term so that RO-Crate previewer has something to link to instead of the 404 Not Found pages https://codemeta.github.io/terms/developmentStatus

However, while each term is defined on https://codemeta.github.io/terms/ textually, there are no HTML anchors there, so https://codemeta.github.io/terms/#developmentStatus for instance would not help much and would still have that dangerous github.io in its non-persistent URL:.

And we can't have multiple DefinedTerm entities with the same "sameAs": "https://codemeta.github.io/terms/" as that would semantically link them all together to the same term.

@dgarijo Could we use the https://w3id.org/codemeta# prefix in sameAs?

   {
    "@id": "https://codemeta.github.io/terms/developmentStatus",
    "@type": ["DefinedTerm", "rdf:Property"],
    "name": "developmentStatus",
    "termCode": "developmentStatus",
    "description": "Description of development status, e.g. Active, inactive, suspended. See repostatus.org",
    "domainIncludes": {"@id": "http://schema.org/SoftwareSourceCode"},
    "rangeIncludes": {"@id": "http://schema.org/Text"}
    "sameAs": "https://w3id.org/codemeta#developmentStatus"
    }

While https://w3id.org/codemeta#developmentStatus does resolve to a HTML page you still have to scroll down and look for "developmentStatus" but at least it's a persistent URL for each term, and also in the promised namespace-to-come.

Related question is if sameAs should rather be as an object reference to match with schema.org JSON-LD mapping as an object property:

"sameAs": { "@id": "https://w3id.org/codemeta#developmentStatus" }

@stain
Copy link
Contributor Author

stain commented Jul 11, 2024

@dgarijo could you also check if I got the domainIncludes and rangeIncludes correct? https://github.com/ResearchObject/ro-crate/pull/276/files#diff-391353380a9c2b594e12f6735db992305846175ab2c59389fc314ee9c5aafa37R767

@stain stain added this to the RO-Crate 1.2 milestone Jul 11, 2024
@stain
Copy link
Contributor Author

stain commented Jul 11, 2024

I got it wrong above, I see codemeta/codemeta#360 (reply in thread) suggests https://w3id.org/codemeta/terms/ as namespace, so I've added that, e.g.

{
    "@id": "https://codemeta.github.io/terms/buildInstructions",
    "@type": ["DefinedTerm", "rdf:Property"],
    "sameAs": "https://w3id.org/codemeta/terms/buildInstructions"
}

@stain
Copy link
Contributor Author

stain commented Aug 22, 2024

@dgarijo Can you confirm I got this right now..?

@dgarijo
Copy link
Contributor

dgarijo commented Aug 23, 2024

Will complete a review by the end of the week.

Copy link
Contributor

@dgarijo dgarijo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating this. It looks good.
I think some of the domains may be also SoftwareApplication, but let us leave it consistent with https://github.com/codemeta/codemeta/blob/master/crosswalk.csv#L63.
Please note that developmentStatus is under discussion, the range may change to a URL. But I don't know when.
Nice idea adding the sameAs to the /terms ns. I will try and resurrect the thread once September starts.

@stain stain merged commit 9f9bd85 into main Aug 29, 2024
1 check passed
@stain stain deleted the codemeta branch August 29, 2024 09:57
@elichad elichad mentioned this pull request Sep 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants