{"Package":"vfinputs","Type":"Package","Title":"Visual Filter Inputs for Shiny","Version":"0.1.0","Date":"2020-09-28","Authors@R":"c(\nperson(\"Rafael\", \"Henkin\", email = \"r.henkin@qmul.ac.uk\", role = c(\"cre\", \"aut\"), comment = c(ORCID = \"0000-0002-5511-5230\")),\nperson(\"Mike\", \"Bostock\", role = c(\"cph\"), comment = \"D3.js library, https://d3js.org\")\n)","Depends":"R (>= 3.0.2)","Imports":"shiny, htmltools, jsonlite, scales","Suggests":"RColorBrewer, testthat","Maintainer":"Rafael Henkin ","Description":"A set of visual input controls for Shiny apps to facilitate filtering across multiple outputs.","License":"GPL-3","LazyData":"TRUE","RoxygenNote":"7.1.1","Encoding":"UTF-8","URL":"https://github.com/rhenkin/vfinputs","BugReports":"https://github.com/rhenkin/vfinputs/issues","NeedsCompilation":"no","Packaged":"2020-10-02 09:42:34 UTC; rafael","Author":"Rafael Henkin [cre, aut] (),\nMike Bostock [cph] (D3.js library, https://d3js.org)","Repository":"CRAN","Date/Publication":"2020-10-13 15:20:03 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/vfinputs_0.1.0.tar.gz","jsonAuthors":[{"name":"Rafael Henkin","email":"r.henkin@qmul.ac.uk","maintainer":true},{"name":"Mike Bostock","email":null,"maintainer":false}],"readme":"\n\n\n# vfinputs\n\n\n\n[![Travis build\nstatus](https://travis-ci.org/rhenkin/vfinputs.svg?branch=main)](https://travis-ci.org/rhenkin/vfinputs)\n\n\n`vfinputs` provides **v**isual **f**ilter **inputs** for Shiny apps. The\ncurrent version includes color legends that enable users of Shiny apps\nto interactively set numeric and categorical filters. Shiny programmers\ncan use the values returned by the inputs to coordinate filtering across\nmultiple outputs, using a unified color legend rather than those\nrendered by a plotting package.\n\n## Installation\n\nYou can install vfinputs with:\n\n``` r\nremotes::install_github(\"rhenkin/vfinputs\")\n```\n\n## Usage\n\nThe inputs should be used as any other Shiny input, added in the UI (or\ncreated using renderUI) and accessed in the server function. At the\nmoment, there are two numeric legends (continuous and discrete) and one\ncategorical one. The numeric legends include a brush interaction to\nselect a range of values. The categorical legend includes a\nclick-to-toggle interaction, with single or multiple selections being\npossible.\n\n``` r\nlibrary(vfinputs)\n\nui <- fluidPage(\n \n # Using minValue, maxValue and colors\n continuousColorFilter(\"filter\", minValue = 0, maxValue = 200, colors = c(\"#ad2a2a\", \"#3f91e8\")),\n \n # Using data and colors\n continuousColorFilter(\"filter2\", data = mtcars$mpg, colors = c(\"#ad2a2a\", \"#3f91e8\")),\n \n # Using data and palette\n continuousColorFilter(\"filter3\", data = mtcars$mpg, palette = scales::viridis_pal())\n \n # Defining the number of colors through n for a discrete selection\n discreteColorFilter(\"filter4\", minValue = 0, maxValue = 200, colors = c(\"#ad2a2a\", \"#3f91e8\"), n = 5),\n \n # Categorical legend\n categoricalColorFilter(\"filter5\", values = c(\"Yes\", \"No\"), colors = c(\"#FF0000\", \"#FF00FF\"))\n \n # Single selection\n categoricalColorFilter(\"filter5\", values = c(\"Yes\", \"No\"), colors = c(\"#FF0000\", \"#FF00FF\"), multiple = FALSE)\n )\n```\n\nThe numeric legends return `start` and `end` values of the brushed\ninterval. The categorical legend returns a list with the selected\nvalues.\n\n``` r\nserver <- function(input, output) {\n output$value <- output$selection <- renderPrint({\n if (!is.null(input$filter)) {\n paste0(input$filter$start, \",\", input$filter$end)\n }\n })\n }\n```\n\nFor detailed examples of how to use the different arguments see the\n`visualtests` folder in this repository.\n\n### Customizing and extending\n\n**Ticks and labels**\n\nUnder the hood, the axes and brushes are implemented using\n[D3.js](https://d3js.org). The `options` argument for the numeric scales\ncan contain custom `\"format\"` for the labels and `\"ticks\"` for deciding\nwhich/how many ticks to show. For the supported format strings, please\nsee . Ticks can be a\nnumber or a list with custom tick values to display.\n\n**CSS**\n\nThe style of the legends, including axis and brush, can easily\ncustomized with CSS, just like any other Shiny input. The key classes to\nlook for are `\"div.continuous-color-filter\"`,\n`\"div.discrete-color-filter\"` and `\"div.categorical-color-filter\"`.\nAdditional elements can be found and customized using the browser\ninspecting tool.\n\n**Custom axis and interaction**\n\nThe key purpose of the UI functions is to connect the rendering of the\ncolor legend with the D3-powered interaction. Thus, the package also\nexports the base functions that creates the color legends ,\n`numericLegend()` and `categoricalLegend()`, and which can be combined\nwith custom JavaScript code to re-implement the axes and brushes.","jobInfo":{"package":"vfinputs","version":"0.1.0","parsingStatus":"success","parserVersion":1,"parsedAt":"2020-10-13T17:29:58+0000"}}

Description

Usage

Arguments

Details

See Also