higlass / higlass/higlass-python

Display PNG preview when notebook is shown statically

Open
#49 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
66
Forks
11
PR merge metrics
No merged PRs in 30d

Description

This notebook, for example, has a few HiGlass views but they're not visible when previewed in GitHub: https://github.com/reservoirgenomics/paper-data/blob/master/boyle-et-al-2019/Boyle%20et%20al.%202019.ipynb

We should store a PNG of the higlass dashboard and preview that.

Relevant thread: https://github.com/jupyter-widgets/ipywidgets/issues/2280

A relevant PR: https://github.com/jupyter/nbconvert/pull/901

Docs on the IPython.display object that needs to be updated: once we have image data: https://ipython.readthedocs.io/en/stable/api/generated/IPython.display.html#IPython.display.display

Contributor guide

Open the contributing guide

Research direction

Start with the linked example notebook and the IPython.display documentation, then review the related ipywidgets thread and nbconvert PR for existing approaches to static output. Done means the HiGlass dashboard is stored as PNG data and is visible when the notebook is previewed statically on GitHub.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook, python
Domain
data-visualization
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.