Skip to contents

Input UI components for the radarPlot module

Source: R/radarPlot_module_ui.R
radarPlotInputsUI.Rd

This should be placed in the UI where the inputs should be shown, with an id that matches the id used in the radarPlotServer() and radarPlotOutputUI() functions.

Usage

radarPlotInputsUI(id, data, defaults = NULL, title = NULL, columns = 2)

Arguments

id

The ID for the Shiny module.

data

The data frame used for plot generation.

defaults

A named list of default values for the inputs. An entry may also be a shiny::reactive() or shiny::reactiveVal(); it is resolved with shiny::isolate() to seed the control, and the module then keeps it live (see setup_reactive_defaults()).

title

An optional title for the UI grid.

columns

Number of columns for the UI grid.

Value

A Shiny tagList containing the UI elements

Details

The user inputs for this module are separated from the outputs to allow for more flexible UI design.

The inputs will automatically be organized into a grid layout via the organize_inputs() function, with columns controlling the number of columns in the grid.

Defaults can be set for each input by providing a named list of values to the defaults argument. Provide data with columns for categories (theta) and values (r). For multiple traces, include a grouping column. Nearly all parameters for radarPlot() can be set via these inputs, so see the help for that function for an exhaustive list.

Plot parameters not implemented or with altered functionality

The following radarPlot() parameters are not exposed as UI inputs:

  • palette - Color palette name; use colors via the color picker UI instead

  • legend.x - Legend horizontal position offset (use defaults to set)

  • legend.y - Legend vertical position offset (use defaults to set)

  • title.text - Plot title text (plotly allows interactive editing; use defaults to set)

Plot parameters and defaults

The following radarPlot() parameters can be accessed via UI inputs and/or the defaults argument:

  • theta - Category column for angular axes (UI: "Category column (theta)", default: 1st categorical column)

  • r - Values column for radial distance (UI: "Values column (r)", default: 1st numeric column)

  • group - Optional grouping column for multiple traces (UI: "Group column", default: NULL)

  • fill - Fill area under trace (UI: "Fill area", default: "toself")

  • line.width - Line width (UI: "Line width", default: 2)

  • line.dash - Line dash style (UI: "Line style", default: "solid")

  • marker.size - Marker size (UI: "Marker size", default: 5)

  • marker.symbol - Marker symbol (UI: "Marker symbol", default: "circle")

  • opacity - Trace opacity (UI: "Opacity", default: 0.6)

  • colors - Trace colors (UI: color picker, derived from palette)

  • radial.visible - Show radial axis (UI: "Show radial axis", default: TRUE)

  • radial.range - Radial axis range (UI: "Radial min" and "Radial max", default: auto)

  • radial.showline - Show radial axis line (UI: "Show radial line", default: TRUE)

  • radial.linecolor - Radial axis line color (UI: "Radial line color", default: "#444444")

  • radial.gridcolor - Radial grid color (UI: "Radial grid color", default: "#EEEEEE")

  • angular.direction - Angular axis direction (UI: "Angular direction", default: "clockwise")

  • angular.rotation - Angular axis rotation (UI: "Angular rotation", default: 90)

  • angular.gridcolor - Angular grid color (UI: "Angular grid color", default: "#EEEEEE")

  • title.x - Title horizontal position (UI: "Title horizontal position", default: 0.5)

  • title.font.size - Plot title font size (UI: "Title Size", default: 26)

  • title.font.family - Font family for title text (UI: "Title Font", default: "Arial")

  • title.font.color - Color for plot title (UI: "Title Color", default: "#000000")

  • show.legend - Show legend (UI: "Show legend", default: TRUE)

  • legend.orientation - Legend orientation (UI: "Legend orientation", default: "h")

  • legend.font.family - Legend font (UI: "Legend font", default: "Arial")

  • legend.font.size - Legend font size (UI: "Legend font size", default: 12)

  • legend.font.color - Legend font color (UI: "Legend font color", default: "#000000")

  • bgcolor - Plot background color (UI: "Plot background color", default: "#FFFFFF")

  • polar.bgcolor - Polar area background color (UI: "Polar area background", default: "#FFFFFF")

  • trace.colors - Named character vector mapping group levels to colors, e.g. c(A = "#FF0000", B = "blue") (UI: "Trace colors"). Seeds the picker; unnamed groups fall back to the default palette and user edits take precedence.

  • single.color - Trace color used when no grouping is set (UI: "Trace color:", default: "#1F77B4")

See also

radarPlot(), organize_inputs(), radarPlotOutputUI(), radarPlotServer(), radarPlotApp()

Author

Jacob Martin

Examples

if (FALSE) { # interactive()
library(VizModules)
skills <- data.frame(
    category = c("Speed", "Strength", "Defense", "Stamina", "Speed"),
    value = c(8, 6, 7, 9, 8)
)
radarPlotInputsUI("radarPlot", skills)
}