forked from rte-antares-rpackage/manipulateWidget
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into develop # Conflicts: # DESCRIPTION
- Loading branch information
Showing
6 changed files
with
164 additions
and
109 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,3 +4,6 @@ README.rmd | |
| README.md | ||
| img | ||
| README_files | ||
| ^appveyor\.yml$ | ||
| ^\.travis\.yml$ | ||
| ^codecov\.yml$ | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # R for travis: see documentation at https://docs.travis-ci.com/user/languages/r | ||
|
|
||
| language: R | ||
| sudo: false | ||
| cache: packages | ||
|
|
||
| after_success: | ||
| - Rscript -e 'covr::codecov()' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,108 +1,108 @@ | ||
| Add more interactivity to interactive charts | ||
| ================ | ||
|
|
||
| [](http://cran.r-project.org/package=manipulateWidget) [](http://cran.r-project.org/package=manipulateWidget) | ||
|
|
||
| This R package is largely inspired by the `manipulate` package from Rstudio. It provides the function `manipulateWidget` that can be used to create in a very easy way a graphical interface that let the user modify the data or the parameters of an interactive chart. Technically, the function generates a Shiny gadget, but the user does not even have to know what is Shiny. | ||
|
|
||
| Why should you use it? | ||
| ---------------------- | ||
|
|
||
| All functionalities of this package can be replicated with other packages like [shiny](https://shiny.rstudio.com/), [flexdashboard](http://rmarkdown.rstudio.com/flexdashboard/), [crosstalk](http://rstudio.github.io/crosstalk/) and others. So why another package? | ||
|
|
||
| `manipulateWidget` has three advantages: | ||
|
|
||
| - It is easy and fast to use. Only a few lines of `R` are necessary to create a user interface. | ||
| - Code can be included in any R script. No need to create a dedicated .R or .Rmd file. | ||
| - It works with all htmlwidgets. In contrast, `crosstalk` only supports a few of them. | ||
|
|
||
| `manipulateWidget` can be especially powerful for users who are exploring some data set and want to quickly build a graphical tool to see what is in their data. `manipulateWidget` has also some advanced features that can be used with almost no additional code and that could seduce some package developers: grouping inputs, conditional inputs and comparison mode. | ||
|
|
||
| Installation | ||
| ------------ | ||
|
|
||
| The package can be installed from CRAN: | ||
|
|
||
| ``` r | ||
| install.packages("manipulateWidget") | ||
| ``` | ||
|
|
||
| You can also install the latest development version from github: | ||
|
|
||
| ``` r | ||
| devtools::install_github("rte-antares-rpackage/manipulateWidget", ref="develop") | ||
| ``` | ||
|
|
||
| Getting started | ||
| --------------- | ||
|
|
||
| The hard part for the user is to write a code that generates an interactive chart. Once this is done, he only has to describe what parameter of the code should be modified by what input control. For instance, consider the following code that identifies clusters in the iris data set and uses package `plotly` to generate an interactive scatter plot. | ||
|
|
||
| ``` r | ||
| library(plotly) | ||
| data(iris) | ||
|
|
||
| plotClusters <- function(xvar, yvar, nclusters) { | ||
| clusters <- kmeans(iris[, 1:4], centers = nclusters) | ||
| clusters <- paste("Cluster", clusters$cluster) | ||
|
|
||
| plot_ly(x = ~iris[[xvar]], y = ~iris[[yvar]], color = ~clusters, | ||
| type = "scatter", mode = "markers") %>% | ||
| layout(xaxis = list(title=xvar), yaxis = list(title=yvar)) | ||
| } | ||
|
|
||
| plotClusters("Sepal.Width", "Sepal.Length", 3) | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| Once this code has been written, it is very easy to produce a UI that lets the user change the values of the three parameters of the function `plotClusters`: | ||
|
|
||
| ``` r | ||
| varNames <- names(iris)[1:4] | ||
|
|
||
| manipulateWidget( | ||
| plotClusters(xvar, yvar, nclusters), | ||
| xvar = mwSelect(varNames), | ||
| yvar = mwSelect(varNames, value = "Sepal.Width"), | ||
| nclusters = mwSlider(1, 10, value = 3) | ||
| ) | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| The package also provides the `combineWidgets` function to easily combine multiple interactive charts in a single view. Of course both functions can be used together: here is a more complex example that uses packages `dygraphs` and `plot_ly`. | ||
|
|
||
| ``` r | ||
| myPlotFun <- function(distribution, range, title) { | ||
| randomFun <- switch(distribution, gaussian = rnorm, uniform = runif) | ||
| myData <- data.frame( | ||
| year = seq(range[1], range[2]), | ||
| value = randomFun(n = diff(range) + 1) | ||
| ) | ||
| combineWidgets( | ||
| ncol = 2, colsize = c(2, 1), | ||
| dygraph(myData, main = title), | ||
| combineWidgets( | ||
| plot_ly(x = myData$value, type = "histogram"), | ||
| paste( | ||
| "The graph on the left represents a random time series generated using a <b>", | ||
| distribution, "</b>distribution function.<br/>", | ||
| "The chart above represents the empirical distribution of the generated values." | ||
| ) | ||
| ) | ||
| ) | ||
|
|
||
| } | ||
|
|
||
| manipulateWidget( | ||
| myPlotFun(distribution, range, title), | ||
| distribution = mwSelect(choices = c("gaussian", "uniform")), | ||
| range = mwSlider(2000, 2100, value = c(2000, 2100), label = "period"), | ||
| title = mwText() | ||
| ) | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| For more information take a look at the package vignettes. | ||
| Add more interactivity to interactive charts | ||
| ================ | ||
|
|
||
| [](http://cran.r-project.org/package=manipulateWidget) [](http://cran.r-project.org/package=manipulateWidget)[](https://ci.appveyor.com/project/rte-antares-rpackage/manipulateWidget)[](https://travis-ci.org/rte-antares-rpackage/manipulateWidget)[](https://codecov.io/github/rte-antares-rpackage/manipulateWidget?branch=master) | ||
|
|
||
| This R package is largely inspired by the `manipulate` package from Rstudio. It provides the function `manipulateWidget` that can be used to create in a very easy way a graphical interface that let the user modify the data or the parameters of an interactive chart. Technically, the function generates a Shiny gadget, but the user does not even have to know what is Shiny. | ||
|
|
||
| Why should you use it? | ||
| ---------------------- | ||
|
|
||
| All functionalities of this package can be replicated with other packages like [shiny](https://shiny.rstudio.com/), [flexdashboard](http://rmarkdown.rstudio.com/flexdashboard/), [crosstalk](http://rstudio.github.io/crosstalk/) and others. So why another package? | ||
|
|
||
| `manipulateWidget` has three advantages: | ||
|
|
||
| - It is easy and fast to use. Only a few lines of `R` are necessary to create a user interface. | ||
| - Code can be included in any R script. No need to create a dedicated .R or .Rmd file. | ||
| - It works with all htmlwidgets. In contrast, `crosstalk` only supports a few of them. | ||
|
|
||
| `manipulateWidget` can be especially powerful for users who are exploring some data set and want to quickly build a graphical tool to see what is in their data. `manipulateWidget` has also some advanced features that can be used with almost no additional code and that could seduce some package developers: grouping inputs, conditional inputs and comparison mode. | ||
|
|
||
| Installation | ||
| ------------ | ||
|
|
||
| The package can be installed from CRAN: | ||
|
|
||
| ``` r | ||
| install.packages("manipulateWidget") | ||
| ``` | ||
|
|
||
| You can also install the latest development version from github: | ||
|
|
||
| ``` r | ||
| devtools::install_github("rte-antares-rpackage/manipulateWidget", ref="develop") | ||
| ``` | ||
|
|
||
| Getting started | ||
| --------------- | ||
|
|
||
| The hard part for the user is to write a code that generates an interactive chart. Once this is done, he only has to describe what parameter of the code should be modified by what input control. For instance, consider the following code that identifies clusters in the iris data set and uses package `plotly` to generate an interactive scatter plot. | ||
|
|
||
| ``` r | ||
| library(plotly) | ||
| data(iris) | ||
|
|
||
| plotClusters <- function(xvar, yvar, nclusters) { | ||
| clusters <- kmeans(iris[, 1:4], centers = nclusters) | ||
| clusters <- paste("Cluster", clusters$cluster) | ||
|
|
||
| plot_ly(x = ~iris[[xvar]], y = ~iris[[yvar]], color = ~clusters, | ||
| type = "scatter", mode = "markers") %>% | ||
| layout(xaxis = list(title=xvar), yaxis = list(title=yvar)) | ||
| } | ||
|
|
||
| plotClusters("Sepal.Width", "Sepal.Length", 3) | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| Once this code has been written, it is very easy to produce a UI that lets the user change the values of the three parameters of the function `plotClusters`: | ||
|
|
||
| ``` r | ||
| varNames <- names(iris)[1:4] | ||
|
|
||
| manipulateWidget( | ||
| plotClusters(xvar, yvar, nclusters), | ||
| xvar = mwSelect(varNames), | ||
| yvar = mwSelect(varNames, value = "Sepal.Width"), | ||
| nclusters = mwSlider(1, 10, value = 3) | ||
| ) | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| The package also provides the `combineWidgets` function to easily combine multiple interactive charts in a single view. Of course both functions can be used together: here is a more complex example that uses packages `dygraphs` and `plot_ly`. | ||
|
|
||
| ``` r | ||
| myPlotFun <- function(distribution, range, title) { | ||
| randomFun <- switch(distribution, gaussian = rnorm, uniform = runif) | ||
| myData <- data.frame( | ||
| year = seq(range[1], range[2]), | ||
| value = randomFun(n = diff(range) + 1) | ||
| ) | ||
| combineWidgets( | ||
| ncol = 2, colsize = c(2, 1), | ||
| dygraph(myData, main = title), | ||
| combineWidgets( | ||
| plot_ly(x = myData$value, type = "histogram"), | ||
| paste( | ||
| "The graph on the left represents a random time series generated using a <b>", | ||
| distribution, "</b>distribution function.<br/>", | ||
| "The chart above represents the empirical distribution of the generated values." | ||
| ) | ||
| ) | ||
| ) | ||
|
|
||
| } | ||
|
|
||
| manipulateWidget( | ||
| myPlotFun(distribution, range, title), | ||
| distribution = mwSelect(choices = c("gaussian", "uniform")), | ||
| range = mwSlider(2000, 2100, value = c(2000, 2100), label = "period"), | ||
| title = mwText() | ||
| ) | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| For more information take a look at the package vignettes. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| # DO NOT CHANGE the "init" and "install" sections below | ||
|
|
||
| # Download script file from GitHub | ||
| init: | ||
| ps: | | ||
| $ErrorActionPreference = "Stop" | ||
| Invoke-WebRequest http://raw.github.com/krlmlr/r-appveyor/master/scripts/appveyor-tool.ps1 -OutFile "..\appveyor-tool.ps1" | ||
| Import-Module '..\appveyor-tool.ps1' | ||
| install: | ||
| ps: Bootstrap | ||
|
|
||
| # Adapt as necessary starting from here | ||
|
|
||
| build_script: | ||
| - travis-tool.sh install_deps | ||
|
|
||
| test_script: | ||
| - travis-tool.sh run_tests | ||
|
|
||
| on_failure: | ||
| - 7z a failure.zip *.Rcheck\* | ||
| - appveyor PushArtifact failure.zip | ||
|
|
||
| artifacts: | ||
| - path: '*.Rcheck\**\*.log' | ||
| name: Logs | ||
|
|
||
| - path: '*.Rcheck\**\*.out' | ||
| name: Logs | ||
|
|
||
| - path: '*.Rcheck\**\*.fail' | ||
| name: Logs | ||
|
|
||
| - path: '*.Rcheck\**\*.Rout' | ||
| name: Logs | ||
|
|
||
| - path: '\*_*.tar.gz' | ||
| name: Bits | ||
|
|
||
| - path: '\*_*.zip' | ||
| name: Bits |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| comment: false |