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

Rework ScholarlyArticle #16

Closed
HLWeil opened this issue Mar 25, 2024 · 14 comments
Closed

Rework ScholarlyArticle #16

HLWeil opened this issue Mar 25, 2024 · 14 comments
Assignees

Comments

@HLWeil
Copy link
Member

HLWeil commented Mar 25, 2024

  • It is not clear from the profile which property in the profile maps to which property in ISA
  • PubMedID might be number, must not be an URI
  • naming of fields seems a bit forced

Maybe a possible solution might be to use the Identifier field and use PropertyValues to create combinations of a context for describing what kind of resource is being referenced and the actual reference. E.g.

[
  {
  "category": "DOI",
  "value": "11.1111/abcdef123456789"
  },
  {
  "category": "PMID",
  "value":  "12345678"
  }
]
@floWetzels
Copy link
Collaborator

The missing mapping to ISA terms is a good catch indeed. Maybe it makes sense to add the corresponding ISA term to the property description whenever possible. What do you think, @stuzart?

@floWetzels
Copy link
Collaborator

Regarding the PubMedID and DOI, this is something that the ARC handles in comments, right? They are not part of ISA, as far as I can see. I like the solution via the identifier field, but should it be part of the profile?

@floWetzels
Copy link
Collaborator

Regarding the last bullet point, I think this needs to be specified. I don't know what you mean by that, @HLWeil.

@HLWeil
Copy link
Member Author

HLWeil commented May 13, 2024

Regarding the PubMedID and DOI, this is something that the ARC handles in comments, right? They are not part of ISA, as far as I can see. I like the solution via the identifier field, but should it be part of the profile?

No, these are actually part of the ISA-Model (e.g. see here). So we would just use Identifier and describe the intended usage in the profile?

@stuzart
Copy link
Collaborator

stuzart commented May 14, 2024

I think it would be OK to use identifier in these cases for DOI or Pubmed. It could either be a URL, but if it needs to give more info about the category then it can also be a PropertyMap. The JSONLD example on schema.org shows

"identifier": {
 "@type": "PropertyValue",
   "propertyID": "OCoLC",
   "value":  "889647468"
  },

so I think this could be used if needed, but generally I think just URL would be fine.

@floWetzels
Copy link
Collaborator

Agreed, I think the profile and our tools should allow both options.

@floWetzels
Copy link
Collaborator

@stuzart Do you agree to add the mapped ISA terms to the descriptions?

@HLWeil
Copy link
Member Author

HLWeil commented May 27, 2024

@floWetzels, you mean mention what ISA-Json properties are covered by which Schema.org profiles?

IMO we really need this somewhere. Alternatively, we could create a mapping table like the one for MIAPPE?

@HLWeil
Copy link
Member Author

HLWeil commented May 27, 2024

Agreed, I think the profile and our tools should allow both options.

I disagree with this, I think we should decide on one option to reduce strain and error-proneness of parsers. Especially sameAs is a bit of an arbitrary mapping.

Although I must say that 'URL' does also make intuitive sense. But then would we also use it generically like identifier or would it mean one specific online resource type like a DOI?

@HLWeil
Copy link
Member Author

HLWeil commented May 27, 2024

@floWetzels @stuzart

@kMutagene kMutagene added the Status: Needs Triage This item is up for investigation. label Jun 18, 2024
@floWetzels
Copy link
Collaborator

Agreed, I think the profile and our tools should allow both options.

I disagree with this, I think we should decide on one option to reduce strain and error-proneness of parsers. Especially sameAs is a bit of an arbitrary mapping.

Although I must say that 'URL' does also make intuitive sense. But then would we also use it generically like identifier or would it mean one specific online resource type like a DOI?

What do you mean by sameAs? It was never mentioned before.
I think @stuzart and I agreed on using identifier for things like DOIs, ORCIDs, PubMedIDs, etc. What we meant by allowing both options is that you can either use a simple URL in the identifier property (which is perfectly valid for DOIs or ORCIDs, don't know how PubMedIDs work) or a PropertyValue, which encodes the type of ID and a number/key.
In my opinion, this is a very reasonable use case and we should allow it, but I might be overlooking something.

@HLWeil
Copy link
Member Author

HLWeil commented Jun 24, 2024

The sameAs was already part of the profile prior to this PR. It was used to denote the PubmedID, I think. Therefore it should be thrown out if we switch to the identifier approach.

@HLWeil
Copy link
Member Author

HLWeil commented Jun 24, 2024

What we meant by allowing both options is that you can either use a simple URL in the identifier property (which is perfectly valid for DOIs or ORCIDs, don't know how PubMedIDs work) or a PropertyValue, which encodes the type of ID and a number/key. In my opinion, this is a very reasonable use case and we should allow it, but I might be overlooking something.

Oh okay I see, yeah that definitely makes sense.

@floWetzels
Copy link
Collaborator

I will close this issue now, as the remaining mapping documentation has its own issue now: #20

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

No branches or pull requests

4 participants