figlet: FIGlet

Description Usage Arguments Value Examples

View source: R/figlet.R

Description

FIGlet

Usage

1
2
3
4
5
6
7
8
figlet(
  text,
  font = "standard",
  width = getOption("width", 80),
  justify = "left",
  absolute = FALSE,
  strip = TRUE
)

Arguments

text

Text to make bigger

font

Name of font, path to font, or figlet_font object; see figlet_font for details

width

Width to use when justifying and breaking lines

justify

Text justification to use in rendering ("left", "centre", "right")

absolute

Logical, indicating if alignment is absolute (relative to width). Has an effect when justify is right or centre only.

strip

Logical, indicating if whitespace (trailing, plus leading/trailing empty lines) should be removed.

Value

An object of class figlet_text which is a character vector with a handy print method and attributes font and text

Examples

1
rfiglet::figlet("FIGlet")

richfitz/rfiglet documentation built on Feb. 12, 2021, 1:41 a.m.