inm7/annotate.inm7.de-data
8
0
Fork 1
Code Issues 10 Pull requests Packages Activity

Document datalad-catalog entities not covered by the flat schemas #24

New issue
Open
opened 2025-07-18 08:58:03 +00:00 by jsheunis · 2 comments
jsheunis commented 2025-07-18 08:58:03 +00:00
Owner
Copy link

We have several instances of datalad-catalog catalogs running that would all benefit from switching over to a shacl-vue-based contribution workflow.

What would be necessary to achieve this is to have a flat schema that covers all properties in the catalog schema, such that a shacl-vue editor can be deployed per catalog. The entered metadata records would then need to be transform from the flat-X schema into datalad-catalog-compatible records.

It seems, currently, that flat-data would be the closest match to what we need. First we need to identify the classes and slots that are missing in order to generate datalad-catalog-compatible records:

From #17 we have:

  • author(s)
  • homepage
  • doi
  • license
  • funding
  • publications

These are the properties of a dataset in datalad-catalog, taken from https://github.com/datalad/datalad-catalog/blob/main/datalad_catalog/catalog/schema/jsonschema_dataset.json:

  • dataset_id
  • dataset_version
  • name
  • short_name
  • alias
  • description
  • doi
  • url
  • download_url
  • homepage_url
  • license
  • authors
  • access_request_contact
  • access_request_url
  • keywords
  • funding
  • publications
  • subdatasets
  • metadata_sources
  • additional_display
  • top_display
  • notebooks

Some related issues:

We have several instances of `datalad-catalog` catalogs running that would all benefit from switching over to a `shacl-vue`-based contribution workflow. What would be necessary to achieve this is to have a flat schema that covers all properties in the catalog schema, such that a shacl-vue editor can be deployed per catalog. The entered metadata records would then need to be transform from the `flat-X` schema into `datalad-catalog`-compatible records. It seems, currently, that `flat-data` would be the closest match to what we need. First we need to identify the classes and slots that are missing in order to generate `datalad-catalog`-compatible records: From https://hub.psychoinformatics.de/inm7/annotate.inm7.de-data/issues/17 we have: - [x] author(s) - [x] homepage - [ ] doi - [x] license - [ ] funding - [ ] publications These are the properties of a dataset in `datalad-catalog`, taken from https://github.com/datalad/datalad-catalog/blob/main/datalad_catalog/catalog/schema/jsonschema_dataset.json: - [ ] `dataset_id` - [ ] `dataset_version` - [x] `name` - [x] `short_name` - [ ] `alias` - [x] `description` - [ ] `doi` - [ ] `url` - [x] `download_url` - [ ] `homepage_url` - [x] `license` - [x] `authors` - [x] `access_request_contact` - [x] `access_request_url` - [ ] `keywords` - [ ] `funding` - [ ] `publications` - [ ] `subdatasets` - [ ] `metadata_sources` - [ ] `additional_display` - [ ] `top_display` - [ ] `notebooks` Some related issues: - https://hub.psychoinformatics.de/inm7/annotate.inm7.de-data/issues/17 - https://hub.psychoinformatics.de/inm7/annotate.inm7.de-data/issues/13 - https://hub.psychoinformatics.de/inm7/annotate.inm7.de-data/issues/12 - https://github.com/datalad/datalad-catalog/issues/482
adina commented 2025-07-24 18:09:31 +00:00
Owner
Copy link

I have started to add "authors" and "contact" in inm7/inm7-concepts#87. If I understand it correctly, this takes care of "authors", "access_request_contact", and "access_request_url". I'm adding checkmarks to the issue to tick off what we have.

I have started to add "authors" and "contact" in https://hub.psychoinformatics.de/inm7/inm7-concepts/pulls/87. If I understand it correctly, this takes care of "authors", "access_request_contact", and "access_request_url". I'm adding checkmarks to the issue to tick off what we have.
adina commented 2025-07-24 18:13:35 +00:00
Owner
Copy link

I believe "short_name" and "name" of a Dataset are covered in the Dataset class of flat-data.
Because a Dataset is a "Thing" I believe it also already has a "description".

I believe "short_name" and "name" of a Dataset are covered in the Dataset class of flat-data. Because a Dataset is a "Thing" I believe it also already has a "description".
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
config-pid
No results found.
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
inm7/annotate.inm7.de-data#24
No description provided.