dumbbell_plot: dumbbell_plot

Description

R wrapper for @visa/dumbbell-plot via htmlwidgets.

Here is an example of dumbbell-plot in action:

example dumbbell plot

Usage

dumbbell_plot(
  data,
  ordinalAccessor,
  valueAccessor,
  seriesAccessor,
  mainTitle = "",
  subTitle = "",
  accessibility = list(),
  props = list(),
  ...
)

Value

a visaChart htmlwidget object for plotting a dumbbell plot

Arguments

data: required to be a valid, R data frame. Data used to create chart, an array of objects which includes keys that map to chart accessors.
ordinalAccessor: String. Key used to determine dumbbell's categorical property. (similar to x in ggplot)
valueAccessor: String. Key used to determine dumbbell's numeric property. (similar to y in ggplot)
seriesAccessor: String. Key used to determine dumbbell's series.
mainTitle: String. The dynamic tag of title for the map (or you can create your own separately). See highestHeadingLevel prop for how tags get assigned.
subTitle: String. The dynamic tag for a sub title for the map (or you can create your own separately). See highestHeadingLevel prop for how tags get assigned.
accessibility: List(). Manages messages and settings for chart accessibility, see object definition
props: List(). A valid R list with additional property configurations, see all props for @visa/dumbbell-plot
...: All other props passed into the function will be passed through to the chart, see all props for @visa/dumbbell-plot.

Details

To see all available options for the chart properties/API see @visa/dumbbell-plot.

Examples

Run this code

library(dplyr)
data.frame(UCBAdmissions) %>%
  filter(Admit == "Rejected") %>%
  dumbbell_plot("Dept","Freq","Gender")

Run the code above in your browser using DataLab