marinebon / infographiqR

R functions for creation of interactive intelligent infographics, ie infographiq
https://marinebon.github.io/infographiqR
MIT License
11 stars 2 forks source link

Should infographiqR repo exist? #63

Closed superjai closed 3 years ago

superjai commented 3 years ago

Hey @bbest - I have completed the rewrite of the infographiq javascript and the reorganization of cinms. After doing all of this, it doesn't seem like that the infographiqR repo serves much purpose.

Here's the reasoning. You have drawn a clear distinction between 1) the code needed to generate the infographic itself and 2) the code generating the modal windows. To this end, you split nms4r into two repos, with the repos containing the following r files:

If you take a look at the functions contained within the original render_rmd.R, you'll see that almost all of them have to do with modal window generation, not infographic generation:

You can see that only the last two functions create_website and get_modal_info of the 18 total have anything at all to do with infographic generation. Consequently, I moved the 16 other functions into onmsR into a R file called render_modal.R.

So that leaves us with two functions in render_rmd.R in infographiqR. And I would argue that these shouldn't be here either.

bbest commented 3 years ago

I appreciate these points Jai, but let's distinguish between these repositories for different aspects of interactive infographic creation and maintenance:

  1. infographiqJS: core JavaScript functionality open a modal or new window from icons in SVG or link in table of contents; and stops short of how to populate the modal window.

  2. onmsR: dataset-specific wrangling and visualization for populating into the modal windows, but could also be used outside of any interactive infographic generation altogether, ie static or dynamic Condition Reports, etc.

  3. infographiqR: support functions in R (NOT core JS, NOT specific visualizations) to generate interactive infographic websites, such as creating a simple Rmarkdown website of infographics, using a glossary to generate tooltips, populating modal templates from Google Sheets with fontawesome icons and links, etc. When Jai says "infographiqR generates the modal" generates the html template (but not the specific visualization contained within the modal)?