Help for package vfinputs

Type:

Package

Title:

Visual Filter Inputs for Shiny

Version:

0.1.0

Date:

2020-09-28

Depends:

R (≥ 3.0.2)

Imports:

shiny, htmltools, jsonlite, scales

Suggests:

RColorBrewer, testthat

Maintainer:

Rafael Henkin <r.henkin@qmul.ac.uk>

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:

Packaged:

2020-10-02 09:42:34 UTC; rafael

Author:

Rafael Henkin

[cre, aut], Mike Bostock [cph] (D3.js library, https://d3js.org)

Repository:

CRAN

Date/Publication:

2020-10-13 15:20:03 UTC

Add list of category items

Description

Add list of category items

Usage

addCategoryBlocks(orient, input_id, color_map, values)

Arguments

orient

Orientation of the legend. Can be "bottom" (default, horizontal with labels below), "top" (horizontal with labels above), "left" (vertical with labels on the left) and "right" (vertical with labels on the right).

input_id

The CSS class used to trigger interactions

color_map

A list of colors from where the corresponding item color will be retrieved

values

A list of values from which the corresponding item label will be retrieved

Value

A list of the same length as values, containing either "span" or "div" elements depending on the chosen orientation.

Add list of colored strips

Description

Add list of colored strips

Usage

addColorStrips(n_strips, color_map, orient, pos_function, size, thickness = 20)

Arguments

n_strips

Number of strips to be added

color_map

A list of colors corresponding to the number of strips

orient

pos_function

A function to convert from index number to pixels

size

The length of the list in pixels

thickness

The height or width of the list in pixels

Value

A list of SVG rect shapes.

Add a visual filter input for categorical data

Description

Add a visual filter input for categorical data

Usage

categoricalColorFilter(inputId, ...)

Arguments

inputId

The input slot that will be used to access the value.

...

Arguments passed on to categoricalLegend

label: Display label for the control, or NULL for no label.
class: The CSS class of the input div element to match with any filter toggling functions. Default class is "categorical-color-filter".
values: List of character vectors that will match with the colors or palette in the order provided by both.
data: Alternative vector to extract values with "unique()" function.
colors: Colours to match with values; must be a valid argument to grDevices::col2rgb(). This can be a character vector of "#RRGGBB" or "#RRGGBBAA", colour names from grDevices::colors(), or a positive integer that indexes into grDevices::palette().
palette: A function that outputs a list of colors.
orient: Orientation of the legend. Can be "bottom" (default, horizontal with labels below), "top" (horizontal with labels above), "left" (vertical with labels on the left) and "right" (vertical with labels on the right).
size: Absolute length in pixels of the color bar; becomes width or height depending on value of orient. Default is 220.
multiple: Is selection of multiple items allowed? Default is TRUE. With FALSE, selecting one item will de-select the others.

Value

A visual filter input control that can be added to a UI definition

Server value

start and end bounds of a selection. The default value (or empty selection) is NULL.

Examples

## Only run examples in interactive R sessions
if (interactive()) {

ui <- fluidPage(
  categoricalColorFilter("filter", data = sort(mtcars$gear), orient = "right",
                           palette = RColorBrewer::brewer.pal(8, "Dark2")),
  verbatimTextOutput("value")
)
server <- function(input, output) {
  output$value <- output$selection <- renderPrint({
  if (!is.null(input$filter)) {
    format(input$filter)
  }
})
}

shinyApp(ui, server)

ui <- fluidPage(
  categoricalColorFilter("filter", label = p("Categorical filter:"),
                           palette = RColorBrewer::brewer.pal(3, "Accent"),
                           values = list("a","b","c")),
  verbatimTextOutput("values")
)
server <- function(input, output) {
  output$value <- output$selection <- renderPrint({
  if (!is.null(input$filter)) {
    format(input$filter)
  }
})
}
shinyApp(ui, server)

}

Create a categorical legend

Description

Create a color legend based on given data and palette or colors. Also passes on data- attributes for optional JS interaction.

Usage

categoricalLegend(
  inputId,
  label = NULL,
  class = "",
  values = NULL,
  data = NULL,
  colors = NULL,
  palette = NULL,
  orient = "bottom",
  size = 220,
  multiple = TRUE
)

Arguments

inputId

The input slot that will be used to access the value.

label

Display label for the control, or NULL for no label.

class

The CSS class of the input div element to match with any filter toggling functions. Default class is "categorical-color-filter".

values

List of character vectors that will match with the colors or palette in the order provided by both.

data

Alternative vector to extract values with "unique()" function.

colors

Colours to match with values; must be a valid argument to grDevices::col2rgb(). This can be a character vector of "#RRGGBB" or "#RRGGBBAA", colour names from grDevices::colors(), or a positive integer that indexes into grDevices::palette().

palette

A function that outputs a list of colors.

orient

size

Absolute length in pixels of the color bar; becomes width or height depending on value of orient. Default is 220.

multiple

Is selection of multiple items allowed? Default is TRUE. With FALSE, selecting one item will de-select the others.

Value

A categorical color legend control that can be added to a UI definition

Add a color-label block

Description

Add a color-label block

Usage

categoryBlock(i, values, tag_name, class, color_map)

Arguments

i

The index of the item to be created

values

A list of values from which the corresponding item label will be retrieved

tag_name

An HTML element tag

class

The HTML element class that will enable interaction

color_map

A list of colors from where the corresponding item color will be retrieved

Value

An HTML element with pointer cursor, a colored square and a label

Add color strip

Description

Add color strip

Usage

colorStrip(color, x = 0, y = 0, width = 1, height = 30)

Arguments

color

A valid CSS color name

x

The x position of the rect shape relative to a container

y

The y position of the rect shape relative to a container

width

The width of the rect

height

The height of the rect

Value

A rect element with the color argument as fill and stroke

Add a visual filter input for continuous values

Description

The brush used in this filter allows a free selection over the whole input range.

Usage

continuousColorFilter(inputId, ...)

Arguments

inputId

The input slot that will be used to access the value.

...

Arguments passed on to numericLegend

label: Display label for the control, or NULL for no label.
class: The CSS class of the input div element to match with any brush-defining functions. Default classes for brushes are either "continuous-color-filter" or "discrete-color-filter".
n: Number of color strips in the legend. Default is 100.
minValue: Minimum numeric value in the legend (can be higher the maximum for inverted scale).
maxValue: Maximum numeric value in the legend (can be lower the minimum for inverted scale).
data: Alternative vector to extract numeric minimum and maximum values.
colors: Colours to interpolate; must be a valid argument to grDevices::col2rgb(). This can be a character vector of "#RRGGBB" or "#RRGGBBAA", colour names from grDevices::colors(), or a positive integer that indexes into grDevices::palette().
palette: A function that outputs a list of colors
options: Configuration options for brush and scale. Use ticks to specify number of ticks or a list of specific tick values , format to a d3-format-compatible formatting string (see https://github.com/d3/d3-format for valid formats) and hide_brush_labels as TRUE to hide the brush interval.
orient: Orientation of the legend. Can be "bottom" (default, horizontal with labels below), "top" (horizontal with labels above), "left" (vertical with labels on the left) and "right" (vertical with labels on the right).
size: Absolute length in pixels of the color bar; becomes width or height depending on value of orient. Default is 200.
thickness: Absolute thickness in pixels of the color bar; opposite of size depending on value of orient. Default is 20.
offset: Left offset for scale to allow long labels. Default is 0.

Value

A visual filter input control that can be added to a UI definition.

Server value

start and end bounds of a selection. The input value is NULL for empty selections.

Examples

## Only run examples in interactive R sessions
if (interactive()) {

ui <- fluidPage(
  continuousColorFilter("filter", minValue = 0, maxValue = 200, palette = scales::viridis_pal()),
  verbatimTextOutput("value")
)
server <- function(input, output) {
  output$value <- output$selection <- renderPrint({
  if (!is.null(input$filter)) {
    paste0(input$filter$start, ",", input$filter$end)
    }
  })
}
shinyApp(ui, server)

ui <- fluidPage(
  continuousColorFilter("filter", data = mtcars$mpg, colors = c("#FF0000", "#0000FF")),
  verbatimTextOutput("value")
)
server <- function(input, output) {
  output$value <- output$selection <- renderPrint({
  if (!is.null(input$filter)) {
    paste0(input$filter$start, ",", input$filter$end)
    }
  })
}
shinyApp(ui, server)

}

Add a visual filter input for discrete values

Description

The brush used in this filter snaps to evenly divided steps based on the number of colors passed as argument. With minValue = 0, maxValue = 100 and n = 5, it will snap at the edges (0 and 100) and 20, 40, 60, and 80.

Usage

discreteColorFilter(inputId, ...)

Arguments

inputId

The input slot that will be used to access the value.

...

Arguments passed on to numericLegend

label: Display label for the control, or NULL for no label.
class: The CSS class of the input div element to match with any brush-defining functions. Default classes for brushes are either "continuous-color-filter" or "discrete-color-filter".
n: Number of color strips in the legend. Default is 100.
minValue: Minimum numeric value in the legend (can be higher the maximum for inverted scale).
maxValue: Maximum numeric value in the legend (can be lower the minimum for inverted scale).
data: Alternative vector to extract numeric minimum and maximum values.
colors: Colours to interpolate; must be a valid argument to grDevices::col2rgb(). This can be a character vector of "#RRGGBB" or "#RRGGBBAA", colour names from grDevices::colors(), or a positive integer that indexes into grDevices::palette().
palette: A function that outputs a list of colors
options: Configuration options for brush and scale. Use ticks to specify number of ticks or a list of specific tick values , format to a d3-format-compatible formatting string (see https://github.com/d3/d3-format for valid formats) and hide_brush_labels as TRUE to hide the brush interval.
orient: Orientation of the legend. Can be "bottom" (default, horizontal with labels below), "top" (horizontal with labels above), "left" (vertical with labels on the left) and "right" (vertical with labels on the right).
size: Absolute length in pixels of the color bar; becomes width or height depending on value of orient. Default is 200.
thickness: Absolute thickness in pixels of the color bar; opposite of size depending on value of orient. Default is 20.
offset: Left offset for scale to allow long labels. Default is 0.

Value

A visual filter input control that can be added to a UI definition.

Server value

start and end bounds of a selection. The input value is NULL for empty selections.

start and end bounds of a selection. The default value is null.

Examples

## Only run examples in interactive R sessions
if (interactive()) {

ui <- fluidPage(
  discreteColorFilter("filter", minValue = 0, maxValue = 200, n = 5,
                        palette = scales::viridis_pal()),
  verbatimTextOutput("value")
)
server <- function(input, output) {
  output$value <- output$selection <- renderPrint({
  if (!is.null(input$filter)) {
    paste0(input$filter$start, ",", input$filter$end)
  }
})
}
shinyApp(ui, server)
}

Create a numeric legend

Description

Create a color legend based on given data and palette or colors. Also passes on data- attributes for optional JS interaction.

Usage

numericLegend(
  inputId,
  label = NULL,
  class = "",
  n = 100,
  minValue = NULL,
  maxValue = NULL,
  data = NULL,
  colors = NULL,
  palette = NULL,
  options = NULL,
  orient = "bottom",
  size = 200,
  thickness = 20,
  offset = 0
)

Arguments

inputId

The input slot that will be used to access the value.

label

Display label for the control, or NULL for no label.

class

The CSS class of the input div element to match with any brush-defining functions. Default classes for brushes are either "continuous-color-filter" or "discrete-color-filter".

n

Number of color strips in the legend. Default is 100.

minValue

Minimum numeric value in the legend (can be higher the maximum for inverted scale).

maxValue

Maximum numeric value in the legend (can be lower the minimum for inverted scale).

data

Alternative vector to extract numeric minimum and maximum values.

colors

Colours to interpolate; must be a valid argument to grDevices::col2rgb(). This can be a character vector of "#RRGGBB" or "#RRGGBBAA", colour names from grDevices::colors(), or a positive integer that indexes into grDevices::palette().

palette

A function that outputs a list of colors

options

Configuration options for brush and scale. Use ticks to specify number of ticks or a list of specific tick values , format to a d3-format-compatible formatting string (see https://github.com/d3/d3-format for valid formats) and hide_brush_labels as TRUE to hide the brush interval.

orient

size

Absolute length in pixels of the color bar; becomes width or height depending on value of orient. Default is 200.

thickness

Absolute thickness in pixels of the color bar; opposite of size depending on value of orient. Default is 20.

offset

Left offset for scale to allow long labels. Default is 0.

Value

A numeric color legend control that can be added to a UI definition

Change a categorical legend in the client

Description

Change a categorical legend in the client

Usage

updateCategoricalFilter(
  session,
  inputId,
  label = NULL,
  select = NULL,
  deselect = NULL
)

Arguments

session

The session object passed to function given to shinyServer.

inputId

The id of the input object.

label

The label to set for the input object.

select

Items to be selected.

deselect

Items to be deselected.

Details

This function only affects the label and the selection. Re-creating the items requires deleting and re-creating the legend using shinyjs, for example.

Change a numeric legend filter in the client

Description

This function does not validate if a brush is already defined; updating only one of start or end with an empty brush will assign the other to NaN.

Usage

updateNumericFilter(
  session,
  inputId,
  label = NULL,
  start = NULL,
  end = NULL,
  minValue = NULL,
  maxValue = NULL
)

Arguments

session

The session object passed to function given to shinyServer.

inputId

The id of the input object.

label

The label to set for the input object.

start

Beginning of selection interval.

end

End of selection interval.

minValue

Minimum numeric value in the legend (can be higher the maximum for inverted scale).

maxValue

Maximum numeric value in the legend (can be lower the minimum for inverted scale).

Details

This function only affects the label and JavaScript-implemented axis and brush values and selection. Re-creating the color strips and changing the ticks and format of values requires deleting and re-creating the legend using shinyjs, for example.

Add list of category items

Description

Usage

Arguments

Value

See Also

Add list of colored strips

Description

Usage

Arguments

Value

See Also

Add a visual filter input for categorical data

Description

Usage

Arguments

Value

Server value

See Also

Examples

Create a categorical legend

Description

Usage

Arguments

Value

See Also

Add a color-label block

Description

Usage

Arguments

Value

Add color strip

Description

Usage

Arguments

Value

Add a visual filter input for continuous values

Description

Usage

Arguments

Value

Server value

See Also

Examples

Add a visual filter input for discrete values

Description

Usage

Arguments

Value

Server value

See Also

Examples

Create a numeric legend

Description

Usage

Arguments

Value

See Also

Change a categorical legend in the client

Description

Usage

Arguments

Details

See Also

Change a numeric legend filter in the client

Description

Usage

Arguments

Details

See Also