Thank you for considering to contribute to g2r!
Please go through this checklist before submitting a PR.
Updated documentation (roxygen2)
Added, or changed the vignettes
g2r is an htmlwidgets build with packer so it can make use of the
@antv/g2 NPM package and webpack to modularise the code.
make is probably the easiest way.
First, make sure you have packer installed:
Then, clone the project.
As mentioned, packer is used to manage webpack and NPM with R: run the function below install the dependencies.
srcjs directory. The core htmlwidget file is placed in the
srcjs/widget directory, it makes use of various modules in the
Make changes or additions to those file then bundle them with packer.
.js file which breaks
Make sure you bundle for prod which performs all required optimisations (tree-shaking, minification, etc.).
It is advised to make use of the
makefile to ensure one does not miss any of the required steps.
G2.js figures are all handled in the
primitives.R file; if adding a figure please place it in with other such custom figures in
Do not change “primitives” (unless fixing a bug). There should remain a simple, straightforward 1:1 mapping to the G2.js geoms.
Many figures internally use the alter package which interfaces the
Make sure document your functions with roxygen2 with examples, etc. Optionally, add something to the pkgdown site.
Do not introduce new dependencies unless absolutely necessary. If needed them to
Suggests and use the internal
check_package to check whether said package is installed.
NEWS.md file with the changes you have made.