rmi-pacta / pacta.interactive.plot Goto Github PK

Would be nice to show the user how they could use the chart in an .Rmd file or a shiny app.

We currently include peer result data to drive the peer_comparison_chart() example. We should re-assess if/how we do that because I doubt we should be including real peer data.

Thoughts? @AlexAxthelm @jdhoffa @MonikaFu

use jquerylib to manage the jQuery dependency so that a version of jQuery does not have to be included inside of this package

Currently the JS code might be outdated.

Currently, the JS code lives in two different places. It might be a good idea to pick one repo where it lives and make the other use this one common source of truth.

Currently, the interactive charts are built on D3v4 plus some additional D3 libraries. r2d3 handles providing the default D3 libraries, but the additional D3 libraries need to be included in this repo/pkg, which is questionable whether we should actually be doing that and/or whether we need to include their licenses, credit their author/s, etc.

The reason for requiring the additional libraries is often because a certain D3 function was added to the micro library after D3v4 was built, and so it can't be accessed using the default library on its own, e.g. d3.rollup. In other cases, the micro library did not exist or was not included in D3v4, but was included in later versions of D3, e.g. d3-scale-chromatic.

If we depend on D3v6 instead, we will have access to all of the latest and greatest versions of the micro libraries and their functions. However, this may cause some problems with functions that have been deprecated, forcing us to update code that uses them to the current/modern way of doing things, e.g. d3.nest and d3.map

README does not support including interactive JavaScript versions of the charts, but we could include static images of them so a user can quickly see what the intended output should look like, and then could point to the Articles/vignettes on the pkgdown site to see functioning interactive versions that are here: https://2degreesinvesting.github.io/r2dii.interactive/articles/

Currently, not all plots from the report are available.

Currently, you need all the indices and peer data to run it. To make it more useful for an ad hoc analysis, these should be made optional whenever possible.

or should it be pacta.interactive.plot? @AlexAxthelm @jdhoffa @MonikaFu

based on https://github.com/RMI-PACTA/pacta.portfolio.allocate/blob/main/.github/workflows/add-prs-and-issues-to-project.yml