Skip to content

Commit

Permalink
doc: remove references to the hosted sample shiny app
Browse files Browse the repository at this point in the history
  • Loading branch information
juba committed Mar 4, 2024
1 parent 7832e6e commit 2ea1aad
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 21 deletions.
27 changes: 12 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,7 @@ Here is a small preview of what you will get :

![example](https://raw.github.com/juba/scatterD3/master/resources/scatterD3.gif)

- The
[visual guide](https://juba.github.io/scatterD3/articles/introduction.html) gives a list of features and examples.
- The [sample shiny app](https://data.nozav.org/app/scatterD3/) allows to live test the package features and its shiny integration.
The [visual guide](https://juba.github.io/scatterD3/articles/introduction.html) gives a list of features and examples.

## Installation

Expand All @@ -27,13 +25,14 @@ install.packages("scatterD3")
```

Or from Github for the latest development version :

```r
remotes::install_github("juba/scatterD3")
```

## Usage

Quick example of the `scatterD3` function based on the `mtcars` dataset :
Quick example of the `scatterD3` function based on the `mtcars` dataset :

```r
mtcars$names <- rownames(mtcars)
Expand All @@ -50,16 +49,14 @@ See [the visual guide](https://juba.github.io/scatterD3/articles/introduction.ht
## Shiny integration

Like every R HTML widget, shiny integration is straightforward. But as a D3
widget, `scatterD3` is *updatable* : changes in settings or data can be
widget, `scatterD3` is _updatable_ : changes in settings or data can be
displayed via smooth transitions instead of a complete chart redraw, which can
provide interesting visual clues.

Furthermore, `scatterD3` provides some additional handlers and callback hooks
for a more complete JavaScript interactivity and integration.

The [sample scatterD3 shiny app](https://data.nozav.org/app/scatterD3/) allows
you to see the different features described here. You
can [check its source code on GitHub](https://github.com/juba/scatterD3_shiny_app)
You can [check the sample scatterD3 shiny app](https://github.com/juba/scatterD3_shiny_app)
and the [visual guide](https://juba.github.io/scatterD3/articles/introduction.html) for
a better understanding of the different arguments.

Expand Down Expand Up @@ -89,10 +86,10 @@ packer::bundle_prod()

This package has been made possible by :

- Mike Bostock's incredible [d3.js](https://d3js.org/) library and documentation
- [htmlwidgets](https://www.htmlwidgets.org/) packages
- [John Coene](https://twitter.com/jdatap)'s [packer](https://github.com/JohnCoene/packer) package
- Susie Lu's [d3-legend](https://github.com/susielu/d3-legend) module
- Rob Moore's [article on reusable d3.js charts](https://www.toptal.com/d3-js/towards-reusable-d3-js-charts)
- Speros Kokenes' [d3 lasso](https://github.com/skokenes/D3-Lasso-Plugin) plugin
- Evan Wang's [d3-labeler](https://github.com/tinker10/D3-Labeler) plugin
- Mike Bostock's incredible [d3.js](https://d3js.org/) library and documentation
- [htmlwidgets](https://www.htmlwidgets.org/) packages
- [John Coene](https://twitter.com/jdatap)'s [packer](https://github.com/JohnCoene/packer) package
- Susie Lu's [d3-legend](https://github.com/susielu/d3-legend) module
- Rob Moore's [article on reusable d3.js charts](https://www.toptal.com/d3-js/towards-reusable-d3-js-charts)
- Speros Kokenes' [d3 lasso](https://github.com/skokenes/D3-Lasso-Plugin) plugin
- Evan Wang's [d3-labeler](https://github.com/tinker10/D3-Labeler) plugin
8 changes: 2 additions & 6 deletions vignettes/introduction.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -613,16 +613,12 @@ You can also disable mouse wheel zooming (for example when it is interfering wit

### Sample app and source code

The
[sample scatterD3 shiny app](https://data.nozav.org/app/scatterD3/) allows you to see the different features described here. You can [check its source code on GitHub](https://github.com/juba/scatterD3_shiny_app) for a better understanding of the different arguments.
You can [check the sample scatterD3 shiny app and its source code on GitHub](https://github.com/juba/scatterD3_shiny_app) for a better understanding of the different arguments.

### Transitions

Like every R HTML widget, shiny integration is straightforward. But as a D3 widget, `scatterD3` is *updatable* : changes in settings or data can be displayed via smooth transitions instead of a complete chart redraw, which can provide interesting visual clues.

For a small demonstration of these transitions, you can take a look at the
[sample scatterD3 shiny app](https://data.nozav.org/app/scatterD3/).

Enabling transitions in your shiny app is quite simple, you just have to add the `transitions = TRUE` argument to your `scatterD3` calls in your shiny server code. There's only one warning : if your shiny application may filter on your dataset rows via a form control, then you must provide a `key_var` variable that uniquely and persistently identify your rows.


Expand All @@ -639,7 +635,7 @@ When used outside of a shiny app, they just center the viewport on the specified
scatterD3(data = mtcars, x = wt, y = mpg, zoom_on = c(1.615, 30.4), zoom_on_level = 6, lab = names)
```

Inside a shiny app, these arguments allow to zoom on a specific point programmatically with transitions. See the [sample scatterD3 shiny app](https://data.nozav.org/app/scatterD3/) for a demonstration.
Inside a shiny app, these arguments allow to zoom on a specific point programmatically with transitions.


### Additional controls : Reset zoom, SVG export, lasso toggle
Expand Down

0 comments on commit 2ea1aad

Please sign in to comment.