crosstalk v1.1.0.1

0

Monthly downloads

0th

Percentile

Inter-Widget Interactivity for HTML Widgets

Provides building blocks for allowing HTML widgets to communicate with each other, with Shiny or without (i.e. static .html files). Currently supports linked brushing and filtering.

Readme

Crosstalk Build Status

Crosstalk is a package for R that enhances the htmlwidgets package. It extends htmlwidgets with a set of classes, functions, and conventions for implementing cross-widget interactions (currently, linked brushing and filtering).

Find out more at the documentation website: http://rstudio.github.io/crosstalk/

Building JavaScript assets

(This section is only for developers who intend to modify the JavaScript source code in Crosstalk itself.)

The JavaScript source code in this package lives under javascript/, however the copy that is actually loaded and used during runtime is in minified form at inst/www/js/. Anytime you make changes to javascript/ source files, you must rebuild the minified JS.

To set up your repo for building the minified JS:

  1. First install nvm if you don't have it already.
  2. In the crosstalk repo's root directory, run nvm install; this will install the version of Node.js we need.
  3. Run nvm use to switch to our version of Node.js.
  4. Run npm install to install all Node.js dependencies.

To actually build the minified JS:

  1. Run nvm use (only needed once per terminal session).
  2. Run node node_modules/.bin/grunt (or if you have installed grunt-cli globally, you can just run grunt).

This will run unit tests, lint, and build the JavaScript dist bundle. When making changes to the JavaScript code, you must always do this first, and then build the R package as normal.

Functions in crosstalk

Name Description
filter_select Categorical filter controls
filter_slider Range filter control
maintain_selection Synchronize Shiny brush selection with shared data
getDefaultReactiveDomain Get default reactive domain
is.SharedData Check if an object is SharedData
scale_fill_selection ggplot2 helpers
bscols Arrange HTML elements or widgets in Bootstrap columns
crosstalkLibs Crosstalk dependencies
ClientValue ClientValue object
SharedData An R6 class that represents a shared data frame
No Results!

Last month downloads

Details

Type Package
License MIT + file LICENSE
URL https://rstudio.github.io/crosstalk/
BugReports https://github.com/rstudio/crosstalk/issues
RoxygenNote 6.1.1
Encoding UTF-8
NeedsCompilation no
Packaged 2020-03-12 23:34:05 UTC; jcheng
Repository CRAN
Date/Publication 2020-03-13 10:20:06 UTC

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/crosstalk)](http://www.rdocumentation.org/packages/crosstalk)