jumpingrivers / ibmsunburst Goto Github PK

You might notice that the fonts look a little ugly. In general, I leave fonts as default, so that a user can specify through CSS or with a framework, such as Bootstrap, Semantic. Please let me know if you would like me to change.

IBM's example uses Bootstrap which in turn uses Helvetica Neue.

Dear maintainer,

Please see the problems shown on
https://cran.r-project.org/web/checks/check_results_ibmsunburst.html.

Please correct before 2022-04-24 to safely retain your package on CRAN.

Best,
-k

At the moment the tests check the class of the output of ibmsunburst.

It'd be nice to add tests that check the output against a saved output like what vdiffr does for ggplot2 objects.

Tasks:

• Identify an example or examples of htmlwidget package(s) testing in the wild.

• Apply the setup to this package.

Unfortunately, the source js library does not currently provide event communication. I generally try not to fork and modify the source js, since the maintenance burden then shifts to the R package author. However, we might be able to add some code to communicate events such as click, expand, etc. to the htmlwidget binding to allow for limited integration with Shiny.

We should show people in the vignette how to do an API call to get data, what sort of things they may need in order to do so, and how to interpret the resulting chart.

Resources

• Example workflow: https://gist.github.com/stephlocke/053e047b9a41dcb1fd9fe181e5b5ba1c
• API docs: https://www.ibm.com/watson/developercloud/personality-insights/api/v3/
• About vignettes http://r-pkgs.had.co.nz/vignettes.html

Things to remember

• Any extra libraries like httr mentioned in a vignette need to be added to the DESCRIPTION in the Suggests section

I left comments for some tests that I think should be added. We need to start writing tests that make sure the ibmsunburst() function works as expected.
https://github.com/lockedata/ibmsunburst/blob/master/tests/testthat/tests_basic.R

Tests in a similar package: https://github.com/timelyportfolio/sunburstR/blob/master/tests/testthat/test-basic.R

https://github.com/personality-insights/sunburst-chart/blob/master/package.json#L39

So that we don't forget I wanted to add some documentation of the changes that I made to the source sunburst-chart. The dist version of the library points to the d3v3 version, which also pollutes the global namespace with d3. This means that we will likely conflict with other htmlwidgets that use other versions of d3.

To resolve, I made commits

1. timelyportfolio/sunburst-chart@4b1ef69 - use d3v4 version
2. timelyportfolio/sunburst-chart@8aa4f37 - RStudio Viewer will be updated but as of now requires es5 JavaScript since it is a very outdated. Change .babelrc to target es5 and transpile Object.assign.
3. timelyportfolio/sunburst-chart@97a5c13 - babel the dist version which we use in htmlwidgets/lib

These steps ended up being quite straightforward and minimal but took a little longer than I expected. If we encouter again with an update of the source library, this should be quick and easy.

The v3 API has been in use since early 2017. The ibmsunburst() function should therefore use "v3" as the default in the event of someone not providing a value to the version argument.

Moved from the README

Typical htmlwidgets workflow

• Identify JS source
• Use htmlwidgets starter package
• Add relevant JS files to inst
• Include a sample dataset
• Adjust templates to incorporate JS lib
• Prep any data transformation or specifications needed
• Add testing and documentation
• Prepare for CRAN