arviz-devs / arviz-devs/InferenceObjects.jl

Improving the HTML representation of InferenceData

Open
#10 0 comments 0 reactions 0 assignees View on GitHub
help wanted
Dominant language
Julia
Stars
15
Forks
1
Avg merge
6d 18h
Merged PRs (30d)
1

Description

Python ArviZ has a really nice HTML representation of their `InferenceData` that expands xarray's own fancy HTML representation of `xarray.Dataset`s. I believe this representation uses both CSS and javascript. You can see it in action here: https://python.arviz.org/en/latest/getting_started/XarrayforArviZ.html

Similarly, we use `` show the groups of `InferenceData` and `` to show the plaintext representation of `Dataset`. See, for example, https://julia.arviz.org/stable/working_with_inference_data/. The goal of such a representation is to make it easy for IJulia and Pluto users, as well as users of websites that display `InferenceData` objects, to get a sense for the structure of the data.

There are a few improvements we should consider making:
- [ ] Replace `` with a `

    ` or a `
    `, using CSS to style it and potentially JS to control the dropdowns. This prevents sites that have a custom `` style from breaking the display of `InferenceData`.
    - [ ] Add a fancier HTML representation of `Dataset`. Something like xarray's that allows previewing of some of the array data or expanding the dimensions would be useful.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.