Sharing and interactive visualization chapter

Bioconductor / OrchestratingSingleCellAnalysis

Content for the OSCA Book.

http://bioconductor.org/books/devel/OSCA/

65 stars 37 forks source link

Sharing and interactive visualization chapter #1

Closed kevinrue closed 5 years ago

kevinrue commented 5 years ago

A first attempt to kick off things.

LTLA commented 5 years ago

Formatting comments:

What's up with the triple dashes? Single dashes aren't good enough for you?
Keep an eye on the complexity of your sentences. Some of them could be broken up.
Try not to use package names as section headings, instead describe what it does for people, e.g., "Exploring SummarizedExperiment objects".
I'd prefer to not stick images/iSEE-dataflow.png in the repo. But I'll grudgingly accept it. Note that you'll have to modify rebuild.sh in the Orchestrating repo to cp the images dir.

Also, how are you planning to show the interactiveness? We could put iframes in the book pointing to a shiny server somewhere, if only we had a Shiny server that we could use. Probably better than having static screenshots.

kevinrue commented 5 years ago

I know double and triple dashes turn into en- and em dash, though I can never remember which ones I'm supposed to use. Probably best to stick with single dash in that case.
I'm generally aware of the complexity of sentences. That said, a helpful advice I got from my PhD supervisors is that to get started, anything is good. Cleaning up is easier when something's there in the first place.
Good point.
In my defense, the image was there when I picked up the chapter. Not a problem for me to remove it. I may even have left it influence me into spending/wasting time thinking what text I could write to lead to the figure.

That is the question isn't it? Part of my issue writing anything comes exactly from that point of "how are we illustrating it". We'll think of something and then I'm sure this chapter will write itself.

LTLA commented 5 years ago

Cleaning up is easier when something's there in the first place.

What?! You mean it's not perfect to start with? 🇳🇿 👎

We'll think of something and then I'm sure this chapter will write itself.

I reckon we should go with iframes, plus the commands required to generate them. Anything else would be crappy. Now we just have to find a sucker with a Shiny server who can host this for us.