IDR / idr.openmicroscopy.org

Source for the IDR static website.
https://idr.openmicroscopy.org/about
Creative Commons Attribution 4.0 International
4 stars 16 forks source link

Add studies.json created from studies.tsv #156

Closed will-moore closed 2 years ago

will-moore commented 2 years ago

See https://github.com/IDR/idr-gallery/pull/2#discussion_r826955759

This is one option to publish studies from https://idr.openmicroscopy.org/about/studies.json instead of loading the .tsv from github. This uses a custom template to map from .tsv to create a .json file. NB: some values were missing from number columns, so these columns have to be treated as strings. e.g. 'Acquisitions' missing from `'idr0028-pascualvargas-rhogtpases', 'idr0045-reichmann-zygotespindle' & 'idr0069-caldera-perturbome'.

cc @sbesson

sbesson commented 2 years ago

Deployed at https://snoopycrimecop.github.io/idr.openmicroscopy.org/studies.json for evaluation.

The JSON representation of the studies.tsv data file is interesting and brings me 2 thoughts:

Overall, it seems to me like that what we are trying to build organically in various places is almost an extension of the existing JSON API at https://idr.openmicroscopy.org/api/v0/. Mid-term, having some public endpoint along the lines of https://idr.openmicroscopy.org/api/v0/studies/ would have several advantage in terms of cross-linking concepts and would be easily consumable both internally e.g. by apps or landing pages as well as externally e.g. by notebooks/applications.

Obviously, defining such an API requires some thought and does not align with the timelines for the new gallery app. But if we agreed this was the way forward, it would be interesting to keep it in mind as we are effectively consolidating metadata coming from different sources.

will-moore commented 2 years ago

Closing this for now, as the current github solution is working OK (and we have fallback in place if it fails).