DingWB / PyComplexHeatmap

PyComplexHeatmap: A Python package to plot complex heatmap (clustermap)
https://dingwb.github.io/PyComplexHeatmap/
MIT License
257 stars 28 forks source link

Your wiki page is GitHub theme dependent #20

Closed RamRS closed 1 year ago

RamRS commented 1 year ago

Hi,

The images you use in your wiki page seem to be GitHub theme dependent. I had to change my GitHub theme to view them properly. My default them is "Dark default". When I view the wiki page with that theme, this is what I see:

screenshot - dark theme

But when I switch to the "Light default" theme, I see everything properly:

screenshot - light theme

DingWB commented 1 year ago

Thanks for your feedback. I have changed the figures. Not sure whether it is fixed now. Please try again and let me know.

RamRS commented 1 year ago

Sorry about the late response. And no, it's not fixed yet - in fact, there's no change at all.

RamRS commented 1 year ago

Why am I unable to reopen this issue?

DingWB commented 1 year ago

It's reopened now.

DingWB commented 1 year ago

Please recheck it. Does it work for you now?

RamRS commented 1 year ago

The first image has a white background now for both light and dark themes. The second and third images seem to have a transparent bg. While this does not affect the second image (it still looks weird but not unintelligible), the rownames and colnames in the third heatmap disappear in the dark theme. You should also be able to enable themes and check images on your end.

DingWB commented 1 year ago

Thanks for your feedback. But I will not spend too much time accommodating different github themes cause it is not that important to me. You can switch to a traditional theme to view the wiki/parameter, or you can just save the picture on your own computer for easy access.

RamRS commented 1 year ago

Another option is to have the images as clickable links that opens the image in a new tab (<a href="image.png" target="_blank"><img src="image.png"></a>) and add some text at the beginning of the document stating that if the images don't render properly owing to GitHub themes, click on the image to view it in a new tab - that fixes the problem.

DingWB commented 1 year ago

This is a good suggestion. Could you please modify it and make a pull request?

RamRS commented 1 year ago

I did not know one could fork and modify the wiki, or I'd have contributed in a better manner. I'll fix the images and add links and submit a PR over the next few days.

RamRS commented 1 year ago

For the moment, you're welcome to look at https://github.com/RamRS/PyComplexHeatmap/wiki/Features - the image is stable across themes.

RamRS commented 1 year ago

I have updated the wiki pages to be theme independent. Apparently PRs cannot be created for wiki pages, so please clone https://github.com/RamRS/PyComplexHeatmap.wiki.git, set https://github.com/DingWB/PyComplexHeatmap.wiki.git as a remote and push to that remote to merge in the changes.

DingWB commented 1 year ago

Thank you, Ram. I have already pushed your wiki.git to https://github.com/DingWB/PyComplexHeatmap.wiki.git. Please recheck whether it works.

DingWB commented 1 year ago

BTW, what do you think of this PyComplexHeatmap? Do you have any suggestions for this package?

RamRS commented 1 year ago

I'll check it out. I use ComplexHeatmap A LOT but I stay away from Python so any testing will need to be exclusively for the purpose of testing your package, not during regular usage.

RamRS commented 1 year ago

The wiki looks good BTW.

RamRS commented 1 year ago

Hi, your wiki images are back to being broken after your latest commit. All it takes is to replace the transparent background with a white background on the PNG files. Maybe do that before uploading the images to github?