line_creator {grobblR}

Breaks down character strings into one or several lines, and determines if it would fit into a specific height and width.

Description

Breaks down character strings into one or several lines, and determines if it would fit into a specific height and width.

Usage

line_creator(
  cex_val,
  string,
  height = numeric(),
  width = numeric(),
  units = c("mm"),
  sep = "\n"
)

Arguments

cex_val

The text cex multiplier applied to the string.

string

The character string needed to be broken down into several lines.

height

A numeric value designating the total height of the matrix grob in mm.

width

A numeric value designating the total width of the matrix grob in mm.

units

millimeters

sep

The separator within the character string which designates where a new line should start.

Value

A list containing a vector with each index equal to a line of the broken-down string, a TRUE/FALSE value indicating whether the lines will fit within equal sized rows and the widths in mm of each of the lines.