Skip to contents

Create Plot Vector

Source: R/plot_vector.R
plot_vector.Rd

Create Plot Vector

Usage

plot_vector(
  output = "html",
  fun = NULL,
  data = NULL,
  color = "black",
  xlim = NULL,
  height = 1,
  height_plot = 400,
  width_plot = 1200,
  images = NULL,
  sprintf = "%s",
  assets = "tinytable_assets",
  ...
)

Arguments

output

Output format. One of "html", "latex", "typst", "markdown", etc.

fun

String or function to generate inline plots.

  • Built-in plot types (strings):

    • "histogram": Creates histograms from numeric vectors. Accepts color argument.

    • "density": Creates density plots from numeric vectors. Accepts color argument.

    • "bar": Creates horizontal bar charts from single numeric values. Accepts color (single value, or length-2 vector for bar and background colors in static formats) and xlim arguments.

    • "line": Creates line plots from data frames with x and y columns. Accepts color and xlim arguments.

  • Custom functions:

    • Functions that return ggplot2 objects.

    • Functions that return another function which generates a base R plot, ex: function(x) {function() hist(x)}

    • Note: When using custom ggplot2 functions that return plots with text elements, the text size will normally need to be adjusted because the plot is inserted as a very small image in the table. Text sizes of 1 or smaller often work well (e.g., theme(text = element_text(size = 1))).

  • See the tutorial on the tinytable website for more information.

data

a list of data frames or vectors to be used by the plotting functions in fun.

color

string Name of color to use for inline plots (passed to the col argument base graphics plots in R). For bar plots in static output formats (PNG, PDF, etc.), can be a vector of length 2: c(bar_color, background_color) to show progress against a maximum. Note: Tabulator format only uses the first color.

xlim

Numeric vector of length 2. Controls the range of bar plots.

height

Numeric, the height of the images in the table in em units.

height_plot

Numeric, the height of generated plot images in pixels (default: 400).

width_plot

Numeric, the width of generated plot images in pixels (default: 1200).

images

Character vector, the paths to the images to be inserted. Paths are relative to the main table file or Quarto (Rmarkdown) document.

sprintf

Character string, a sprintf format string to format the generated cell content. Default is "%s" which displays the content as-is. Use this to wrap images or plots in custom markup.

assets

Path to the directory where generated assets are stored. This path is relative to the location where a table is saved.

...

Extra arguments are passed to the function in fun. Important: Custom plotting functions must always have ... as an argument.

Value

A character vector with plot file paths or HTML tags.

Details

This function creates plots by creating a temporary tt() object and applying plot_tt(). It returns a character vector containing the image paths or HTML tags for the plots.

Examples

if (FALSE) { # \dontrun{
# Create histogram plots
plot_data <- list(rnorm(100), rnorm(50))
plot_vector(fun = "histogram", data = plot_data, output = "html")

# Create density plots
plot_vector(fun = "density", data = plot_data, output = "latex")

# Create bar plots from single values
bar_data <- list(0.5, 0.8, 0.3)
plot_vector(fun = "barpct", data = bar_data, output = "html")
} # }