Package 'sparkline'

An HTML dependency for sparkline

Description

An HTML dependency for sparkline

Usage

html_dependency_sparkline()

---

Interactive Sparklines

Description

Create interactive sparklines for inline visualization.

Usage

sparkline(values, ..., width = 60, height = 20, elementId = NULL,
  renderSelector = NULL)

Arguments

values	vector of values to visualize
...	additional options passed to jquery.sparkline; see jquery.sparkline docs
height, width	height and width of sparkline htmlwidget specified in any valid CSS size unit.
elementId	string id as a valid CSS element id.
renderSelector	string as CSS selector to render in a DOM element other than the htmlwidget container

---

Shiny bindings for sparkline

Description

Output and render functions for using sparkline within Shiny applications and interactive Rmd documents.

Usage

sparklineOutput(outputId, width = "60px", height = "20px")

renderSparkline(expr, env = parent.frame(), quoted = FALSE)

Arguments

outputId	output variable to read from
width, height	Must be a valid CSS unit (like '100%', '400px', 'auto') or a number, which will be coerced to a string and have 'px' appended.
expr	An expression that generates a sparkline
env	The environment in which to evaluate expr.
quoted	Is expr a quoted expression (with quote())? This is useful if you want to save an expression in a variable.

---

Add Sparkline Dependencies to Tag or 'htmlwidget'

Description

Add Sparkline Dependencies to Tag or 'htmlwidget'

Usage

spk_add_deps(tag_htmlwidget = NULL)

Arguments

tag_htmlwidget

shiny.tag or htmlwidget to which you would like to add sparkline dependencies

Value

shiny.tag or htmlwidget

Examples

# use spk_add_deps with other htmlwidgets

library(sparkline)
library(formattable)

fw <- as.htmlwidget(
  formattable(
    data.frame(
      id = c("a", "b"),
      sparkline = c(
        spk_chr(runif(10,0,10), type="bar"),
        spk_chr(runif(10,0,5), type="bar")
      ),
      stringsAsFactors = FALSE
    )
  )
)

spk_add_deps(fw)

# use spk_add_deps with htmltools/shiny tags

library(sparkline)
library(htmltools)

div <- tags$div(
  spk_chr(1:10, type="bar")
)

spk_add_deps(div)

---

Character Version of Sparklines

Description

Create a character version ofinteractive sparklines for use with other 'htmlwidgets' or tags.

Usage

spk_chr(values, ..., width = 60, height = 20, elementId = NULL,
  renderSelector = NULL)

Arguments

values	vector of values to visualize
...	additional options passed to jquery.sparkline; see jquery.sparkline docs
width	height and width of sparkline htmlwidget specified in any valid CSS size unit.
height	height and width of sparkline htmlwidget specified in any valid CSS size unit.
elementId	string id as a valid CSS element id.
renderSelector	string as CSS selector to render in a DOM element other than the htmlwidget container

Examples

## Not run: 
  #spk_chr works well with dplyr summarise
  
  library(dplyr)
  library(sparkline)
  library(formattable)
  
  mtcars %>%
    group_by(cyl) %>%
    summarise(
      hp = spk_chr(
        hp, type="box",
        chartRangeMin=0, chartRangeMax=max(mtcars$hp)
      ),
      mpg = spk_chr(
        mpg, type="box",
        chartRangeMin=0, chartRangeMax=max(mtcars$mpg)
      )
    ) %>%
    formattable() %>%
    formattable::as.htmlwidget() %>%
    spk_add_deps()

## End(Not run)

---

Add a Composite to an Existing Sparkline

Description

Add a Composite to an Existing Sparkline

Usage

spk_composite(sparkline = NULL, sparklineToAdd = NULL, ...)

Arguments

sparkline	sparkline to which we would like to add a composite.
sparklineToAdd	sparkline to add to another sparkline
...	extra arguments to modify sparklineToAdd or define a sparkline.

Value

sparkline object

Examples

library(sparkline)

sl1 <- sparkline(
  c(5,4,5,-2,0,3),
  type='bar',
  barColor="#aaf",
  chartRangeMin=-5,
  chartRangeMax=10,
  # set an id that will make it easier to refer
  #  in the next sparkline
  elementId="sparkline-for-composite"
)

sl2 <- sparkline(
  c(4,1,5,7,9,9,8,7,6,6,4,7,8,4,3,2,2,5,6,7),
  type="line",
  fillColor = FALSE,
  lineColor ='red',
  chartRangeMin = -5,
  chartRangeMax = 10
)

# add sparkline as a composite
spk_composite(sl1, sl2)

# add values and options as a composite
spk_composite(
  sl1,
  values=c(4,1,5,7,9,9,8,7,6,6,4,7,8,4,3,2,2,5,6,7),
  options = list(
    type="line",
    fillColor = FALSE,
    lineColor ='red',
    chartRangeMin = -5,
    chartRangeMax = 10
  )
)

# add combination of sparkline and options as a composite
spk_composite(
  sl1,
  sl2,
  options = list(
    type="box"
  )
)

---