linerange: Mini linerange chunk wrapper

View source: R/chunk_images.R

linerangeR Documentation

Mini linerange chunk wrapper

Description

This function is used to insert lineranges into flextable with functions:

  • compose() and as_paragraph(),

  • append_chunks(),

  • prepend_chunks().

Usage

linerange(
  value,
  min = NULL,
  max = NULL,
  rangecol = "#CCCCCC",
  stickcol = "#FF0000",
  bg = "transparent",
  width = 1,
  height = 0.2,
  raster_width = 30,
  unit = "in"
)

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

stickcol

jauge color

bg

background color

width, height

size of the resulting png file in inches

raster_width

number of pixels used as width when interpolating value.

unit

unit for width and height, one of "in", "cm", "mm".

Note

This chunk option requires package officedown in a R Markdown context with Word output format.

PowerPoint cannot mix images and text in a paragraph, images are removed when outputing to PowerPoint format.

See Also

compose(), as_paragraph()

Other chunk elements for paragraph: as_b(), as_bracket(), as_chunk(), as_equation(), as_highlight(), as_i(), as_image(), as_sub(), as_sup(), as_word_field(), colorize(), gg_chunk(), grid_chunk(), hyperlink_text(), lollipop(), minibar(), plot_chunk()

Examples

myft <- flextable(head(iris, n = 10))

myft <- compose(myft,
  j = 1,
  value = as_paragraph(
    linerange(value = Sepal.Length)
  ),
  part = "body"
)

autofit(myft)

flextable documentation built on Oct. 30, 2024, 9:15 a.m.