These functions are offered to help you import and re-export vegawidget functions in your package.

use_vegawidget(s3_class_name = NULL)

use_vegawidget_interactive()

Arguments

s3_class_name

character, name of an S3 class for object to be coerced to a vegaspec; default (NULL) implies no additional class

Value

invisible NULL, called for side effects

Details

use_vegawidget():

Adds vegawidget functions:

In practical terms:

  • adds vegawidget to Imports in your package's DESCRIPTION file.

  • adds processx, rsvg, png, fs to Suggests in your package's DESCRIPTION file.

  • creates R/utils-vegawidget.R

  • at your discretion, delete references to functions you do not want to re-export.

If you have your own S3 class for a spec, specify the s3_class_name argument. You will have to edit R/utils-vegawidget-<s3_class_name>.R:

  • add the code within your class's method for to coerce your object to a vegaspec.

use_vegawidget_interactive():

If you want to add the JavaScript and Shiny functions, use this after running use_vegawidget(). It adds:

In practical terms:

  • adds shiny, dplyr, to Suggests.

  • creates R/utils-vegawidget-interactive.R.

  • at your discretion, delete references to functions you do not want to re-export.