flextable (version 0.5.11)

lollipop: mini lollipop chart chunk wrapper

Description

This function is used to insert lollipop charts into flextable with function compose. It should be used inside a call to as_paragraph

Usage

lollipop(
  value,
  min = NULL,
  max = NULL,
  rangecol = "#CCCCCC",
  bg = "transparent",
  width = 1,
  height = 0.2,
  raster_width = 30,
  positivecol = "#00CC00",
  negativecol = "#CC0000",
  neutralcol = "#CCCCCC",
  neutralrange = c(0, 0),
  rectanglesize = 2
)

Arguments

value

values containing the bar size

min

min bar size. Default min of value

max

max bar size. Default max of value

rangecol

bar color

bg

background color

width, height

size of the resulting png file in inches

raster_width

number of pixels used as width

positivecol

box color of positive values

negativecol

box color of negative values

neutralcol

box color of neutral values

neutralrange

minimal and maximal range of neutral values (default: 0)

rectanglesize

size of the rectangle (default: 2, max: 5) when interpolating value.

Illustrations

See Also

compose, as_paragraph

Other chunk elements for paragraph: as_bracket(), as_b(), as_chunk(), as_image(), as_i(), as_sub(), as_sup(), hyperlink_text(), linerange(), minibar()

Examples

# NOT RUN {
iris$Sepal.Ratio <- (iris$Sepal.Length - mean(iris$Sepal.Length))/mean(iris$Sepal.Length)
ft <- flextable( tail(iris, n = 10 ))

ft <- compose( ft, j = "Sepal.Ratio",   value = as_paragraph(
  lollipop(value = Sepal.Ratio, min=-.25, max=.25)
),
part = "body")

ft <- autofit(ft)
ft
# }

Run the code above in your browser using DataCamp Workspace