Unicode Symbols

Description

A named list containing the unicode character for various box drawing, mathematical, currency, astrological, and other symbols.

Usage

Sym

Format

A named list of characters

Attributes Off

Description

Turns off text attributes in the terminal, including bold text, italics, underline, etc.

Usage

attr_off(...)

Arguments

Details

Use attr_on to turn on attributes.

Value

NULL

See Also

Other style functions: attr_on(), bg_off(), bg_on(), color_off(), color_pair(), fg_off(), fg_on(), make_bg(), make_fg(), make_style(), reset(), style()

Examples

cat("hello world!\n")
attr_on("bf", "ul")
cat("hello world!\n")
attr_off("bf")
cat("hello world!\n")
attr_off()
cat("hello world!\n")

Attributes On

Description

Turns on text attributes in terminal, including bold text, italics, underline, etc. Note that not all terminals support each attribute.

Usage

attr_on(...)

Arguments

Details

Use attr_off to turn off the attributes.

Value

NULL

See Also

Other style functions: attr_off(), bg_off(), bg_on(), color_off(), color_pair(), fg_off(), fg_on(), make_bg(), make_fg(), make_style(), reset(), style()

Examples

cat("hello world!\n")
attr_on("bf", "ul")
cat("hello world!\n")
attr_off()

Turn Off Background Color

Description

Return the background of future terminal text to the default color. Background color is turned on with bg_on.

Usage

bg_off()

Value

NULL

See Also

Other style functions: attr_off(), attr_on(), bg_on(), color_off(), color_pair(), fg_off(), fg_on(), make_bg(), make_fg(), make_style(), reset(), style()

Examples

# Different methods of specifying yellow
bg_on("yellow")
bg_on("#FFFF00")
bg_on(11)
bg_on(255, 255, 0)

# Turn off color
bg_off()

Turn On Background Color

Description

Specifies the background color of all future text written in the terminal bg_on accepts numeric values (RGB or 8-bit color code), hexadecimal characters, or the name of the color. Not all terminals support each possible color.

Usage

bg_on(...)

Arguments

Details

Background color is turned off with bg_off.

Value

NULL

See Also

Other style functions: attr_off(), attr_on(), bg_off(), color_off(), color_pair(), fg_off(), fg_on(), make_bg(), make_fg(), make_style(), reset(), style()

Examples

# Different methods of specifying yellow
bg_on("yellow")
bg_on("#FFFF00")
bg_on(11)
bg_on(255, 255, 0)

# Turn off color
bg_off()

Draw Box

Description

Draws a box of size dim=c(height, width) at yx=c(row,col).

Usage

box_at(
  yx = c(1, 1),
  dim = NULL,
  text = c("|", "|", "-", "-", rep("+", 4)),
  fg = NA,
  bg = NA,
  attr = NA,
  fill = NA,
  fill.bg = NA,
  fill.fg = NA,
  fill.attr = NA
)

Arguments

Value

NULL

See Also

Other drawing functions: draw_arc(), draw_bezier(), draw_circle(), draw_ellipse(), draw_fn(), draw_lerp(), draw_path(), draw_ray(), draw_rect(), draw_shape(), fill_circle(), fill_ellipse(), fill_rect(), fill_shape(), grid_at(), grid_mat(), hline_at(), hline(), vline_at(), vline()

Examples

box_at(yx=c(4,4), dim=c(5,10), text="X")

Clear Text

Description

Clear text from the terminal. Passing values "start" or "end" allow the user to clear specific portions of the screen relative to the cursor.

Usage

clear(x = c("screen", "end", "start"), ...)

Arguments

Value

NULL

Examples

clear()

cat(paste(LETTERS[1:10], collapse="\n"))

clear("start")
clear("end")

Turn Off Colors in Terminal

Description

Return the background and foreground of future terminal text to the default colors.

Usage

color_off()

Value

NULL

See Also

Other style functions: attr_off(), attr_on(), bg_off(), bg_on(), color_pair(), fg_off(), fg_on(), make_bg(), make_fg(), make_style(), reset(), style()

Examples

bg_on("red")
fg_on("yellow")

# Turn off color
color_off()

Create Background & Foreground Color Combination

Description

Returns the ANSI codes for the specified colors. color_pair accepts numeric values (RGB or 8-bit color code), hexadecimal characters, or the name of the color.

Usage

color_pair(fg, bg)

Arguments

Value

ANSI character string

See Also

Other style functions: attr_off(), attr_on(), bg_off(), bg_on(), color_off(), fg_off(), fg_on(), make_bg(), make_fg(), make_style(), reset(), style()

Examples

# Blue background with white text
color_pair("white", "blue")
color_pair("#FFFFFF", "#0000FF")
color_pair(0, 12)
color_pair(c(255, 255, 255), c(0,0,255))

Draw an Arc

Description

Calculate the path of an arc within a grid and print to screen.

Usage

draw_arc(yx, start, end, r = 1, n = 50, text = "x", ...)

Arguments

Value

NULL

See Also

Other drawing functions: box_at(), draw_bezier(), draw_circle(), draw_ellipse(), draw_fn(), draw_lerp(), draw_path(), draw_ray(), draw_rect(), draw_shape(), fill_circle(), fill_ellipse(), fill_rect(), fill_shape(), grid_at(), grid_mat(), hline_at(), hline(), vline_at(), vline()

Examples

draw_arc(yx=c(10,10), start=pi/2, end=pi, r=6)

Draw a Bezier Curve

Description

Calculate the path of a Bezier Curve with up to two control points in a grid and draw to screen.

Usage

draw_bezier(start, end, c1, c2 = NULL, n = 50, text = "x", ...)

Arguments

Value

NULL

See Also

Other drawing functions: box_at(), draw_arc(), draw_circle(), draw_ellipse(), draw_fn(), draw_lerp(), draw_path(), draw_ray(), draw_rect(), draw_shape(), fill_circle(), fill_ellipse(), fill_rect(), fill_shape(), grid_at(), grid_mat(), hline_at(), hline(), vline_at(), vline()

Examples

draw_bezier(start=c(10,1), end=c(10,10), c1=c(1, 3))

Draw a Circle

Description

Calculate the path of a circle in a grid and draw it to screen.

Usage

draw_circle(yx, r = 1, n = 50, text = "x", ...)

Arguments

Value

NULL

See Also

Other drawing functions: box_at(), draw_arc(), draw_bezier(), draw_ellipse(), draw_fn(), draw_lerp(), draw_path(), draw_ray(), draw_rect(), draw_shape(), fill_circle(), fill_ellipse(), fill_rect(), fill_shape(), grid_at(), grid_mat(), hline_at(), hline(), vline_at(), vline()

Examples

draw_circle(yx=c(10,10), r=5)

Draw Ellipse

Description

Calculate the path of an ellipse within a grid and draw to screen.

Usage

draw_ellipse(yx = c(0, 0), rx = 1, ry = 1, n = 50, text = "x", ...)

Arguments

Value

NULL

See Also

Other drawing functions: box_at(), draw_arc(), draw_bezier(), draw_circle(), draw_fn(), draw_lerp(), draw_path(), draw_ray(), draw_rect(), draw_shape(), fill_circle(), fill_ellipse(), fill_rect(), fill_shape(), grid_at(), grid_mat(), hline_at(), hline(), vline_at(), vline()

Examples

draw_ellipse(yx=c(10,10), rx=8, ry = 4)

Draw a Function

Description

Calculate the path within a grid of an user-supplied function and print to screen.

Usage

draw_fn(x1, x2, fn, n = 50, text = "x", ...)

Arguments

Value

NULL

See Also

Other drawing functions: box_at(), draw_arc(), draw_bezier(), draw_circle(), draw_ellipse(), draw_lerp(), draw_path(), draw_ray(), draw_rect(), draw_shape(), fill_circle(), fill_ellipse(), fill_rect(), fill_shape(), grid_at(), grid_mat(), hline_at(), hline(), vline_at(), vline()

Examples

draw_fn(x1=1, x2=10,
  function(x){sqrt(x)}
)

Draw a Line

Description

Interpolate between two points in a grid and draw to sreen.

Usage

draw_lerp(start, end, n = 50, text = "x", ...)

Arguments

Value

NULL

See Also

Other drawing functions: box_at(), draw_arc(), draw_bezier(), draw_circle(), draw_ellipse(), draw_fn(), draw_path(), draw_ray(), draw_rect(), draw_shape(), fill_circle(), fill_ellipse(), fill_rect(), fill_shape(), grid_at(), grid_mat(), hline_at(), hline(), vline_at(), vline()

Examples

draw_lerp(start=c(10,1), end=c(1,3))

Draw Path

Description

Draws text at each supplied coodinate.

Usage

draw_path(coord, text = "x", ...)

Arguments

Value

NULL

See Also

Other drawing functions: box_at(), draw_arc(), draw_bezier(), draw_circle(), draw_ellipse(), draw_fn(), draw_lerp(), draw_ray(), draw_rect(), draw_shape(), fill_circle(), fill_ellipse(), fill_rect(), fill_shape(), grid_at(), grid_mat(), hline_at(), hline(), vline_at(), vline()

Examples

c <- path_circle(yx = c(5,5), r=3)
draw_path(c, text="0")

Draw a Ray

Description

Calculate the path of a ray extending and print to screen.

Usage

draw_ray(start, end, lim = c(64, 128), n = 200, text = "x", ...)

Arguments

Value

NULL

See Also

Other drawing functions: box_at(), draw_arc(), draw_bezier(), draw_circle(), draw_ellipse(), draw_fn(), draw_lerp(), draw_path(), draw_rect(), draw_shape(), fill_circle(), fill_ellipse(), fill_rect(), fill_shape(), grid_at(), grid_mat(), hline_at(), hline(), vline_at(), vline()

Examples

draw_ray(start=c(10,10), end=pi/6)
draw_ray(start=c(10,10), end=pi/6, lim=c(15,15))
draw_ray(start=c(10,10), end=c(4,2))

Draw a Rectangle

Description

Calculate the path of a rectangle in a grid and draw to screen.

Usage

draw_rect(yx1, yx2, text = "x", ...)

Arguments

Value

NULL

See Also

Other drawing functions: box_at(), draw_arc(), draw_bezier(), draw_circle(), draw_ellipse(), draw_fn(), draw_lerp(), draw_path(), draw_ray(), draw_shape(), fill_circle(), fill_ellipse(), fill_rect(), fill_shape(), grid_at(), grid_mat(), hline_at(), hline(), vline_at(), vline()

Examples

draw_rect(c(5,5), c(9,9))

Draw a Shape

Description

Calculate the path of a shape given supplied vertices and draw to screen.

Usage

draw_shape(mat, cycle = TRUE, n = 30, text = "x", ...)

Arguments

Value

NULL

See Also

Other drawing functions: box_at(), draw_arc(), draw_bezier(), draw_circle(), draw_ellipse(), draw_fn(), draw_lerp(), draw_path(), draw_ray(), draw_rect(), fill_circle(), fill_ellipse(), fill_rect(), fill_shape(), grid_at(), grid_mat(), hline_at(), hline(), vline_at(), vline()

Examples

# Right Triangle
draw_shape(rbind(
  c(10,1),
  c(10,10),
  c(1,1)
), cycle=TRUE)

Erase Text

Description

Clear text from the cursor's row . Passing values "start" and "end" allow the user to erase specific portions of the row relative to the cursor.

Usage

erase(x = c("row", "start", "end"), ...)

Arguments

Value

NULL

Examples

cat('hello world!')
erase('row')

Example Program From Vignette

Description

Simple program that asks for a letter and a number and returns another value to screen.

Usage

example_luckynumber()

Value

NULL

Turn Off Foreground Color

Description

Return future terminal text to the default color. Foreground color is turned on with fg_on.

Usage

fg_off()

Value

NULL

See Also

Other style functions: attr_off(), attr_on(), bg_off(), bg_on(), color_off(), color_pair(), fg_on(), make_bg(), make_fg(), make_style(), reset(), style()

Examples

# Different methods of specifying red
fg_on("red")
fg_on("#FF0000")
fg_on(1)
fg_on(255, 0, 0)

# Turn off color
fg_off()

Turn On Foreground Color

Description

Specifies the color of all future text written in the terminal fg_on accepts numeric values (RGB or 8-bit color code), hexadecimal characters, or the name of the color. Not all terminals support each possible color.

Usage

fg_on(...)

Arguments

Details

Foreground color is turned off with fg_off.

Value

NULL

See Also

Other style functions: attr_off(), attr_on(), bg_off(), bg_on(), color_off(), color_pair(), fg_off(), make_bg(), make_fg(), make_style(), reset(), style()

Examples

# Different methods of specifying red
fg_on("red")
fg_on("#FF0000")
fg_on(9)
fg_on(255, 0, 0)

# Turn off color
fg_off()

Draw a Filled-In Circle

Description

Calculate the path of a circle in a grid and draw it to screen.

Usage

fill_circle(yx, r = 1, n = 50, text = "x", ...)

Arguments

Value

NULL

See Also

Other drawing functions: box_at(), draw_arc(), draw_bezier(), draw_circle(), draw_ellipse(), draw_fn(), draw_lerp(), draw_path(), draw_ray(), draw_rect(), draw_shape(), fill_ellipse(), fill_rect(), fill_shape(), grid_at(), grid_mat(), hline_at(), hline(), vline_at(), vline()

Examples

draw_circle(yx=c(10,10), r=5)

Draw a Filled-In Ellipse

Description

Calculate the path of an ellipse within a grid and draw to screen.

Usage

fill_ellipse(yx = c(0, 0), rx = 1, ry = 1, n = 50, text = "x", ...)

Arguments

Value

NULL

See Also

Other drawing functions: box_at(), draw_arc(), draw_bezier(), draw_circle(), draw_ellipse(), draw_fn(), draw_lerp(), draw_path(), draw_ray(), draw_rect(), draw_shape(), fill_circle(), fill_rect(), fill_shape(), grid_at(), grid_mat(), hline_at(), hline(), vline_at(), vline()

Examples

draw_ellipse(yx=c(10,10), rx=8, ry = 4)

Draw a Filled-In Rectangle

Description

Calculate the path of a rectangle in a grid and draw to screen.

Usage

fill_rect(yx1, yx2, text = "x", ...)

Arguments

Value

NULL

See Also

Other drawing functions: box_at(), draw_arc(), draw_bezier(), draw_circle(), draw_ellipse(), draw_fn(), draw_lerp(), draw_path(), draw_ray(), draw_rect(), draw_shape(), fill_circle(), fill_ellipse(), fill_shape(), grid_at(), grid_mat(), hline_at(), hline(), vline_at(), vline()

Examples

draw_rect(c(5,5), c(9,9))

Draw a Filled-In Shape

Description

Calculate the path of a shape given supplied vertices and draw to screen.

Usage

fill_shape(mat, cycle = TRUE, n = 30, text = "x", ...)

Arguments

Value

NULL

See Also

Other drawing functions: box_at(), draw_arc(), draw_bezier(), draw_circle(), draw_ellipse(), draw_fn(), draw_lerp(), draw_path(), draw_ray(), draw_rect(), draw_shape(), fill_circle(), fill_ellipse(), fill_rect(), grid_at(), grid_mat(), hline_at(), hline(), vline_at(), vline()

Examples

# Right Triangle
fill_shape(rbind(
  c(10,1),
  c(10,10),
  c(1,1)
), cycle=TRUE)

Get Keypress

Description

Listen for a keypress, then apply keypress to a function or echo it to the terminal screen. The user must be in a terminal to use getkp; it will not work in RStudio or the R GUI. All actions within R are halted until the keypress is returned.

Usage

getkp(fn = list(), echo = FALSE)

Arguments

Value

character naming the key that was pressed (invisibly).

Examples

f <- list(
	 'up'    = function(){mv(row=-1)},
  'down'  = function(){mv(row=-1)},
	 'left'  = function(){mv(col=-1)},
	 'right' = function(){mv(col=1)}
)
## Not run: 
getkp(fn=f, echo=FALSE)

## End(Not run)

Loop a Keypress

Description

Maintain a loop that listens for a keypress, then applies the keypress to a function or echoes it to the terminal screen. The user must be in a terminal to use getkp; it will not work in RStudio or the R GUI. All actions within R are halted until the keypress is returned.

Usage

getkpl(escape = "escape", fn = list(), echo = FALSE)

Arguments

Value

NULL

Examples

f <- list(
	 'up'    = function(){mv(row=-1)},
  'down'  = function(){mv(row=-1)},
	 'left'  = function(){mv(col=-1)},
	 'right' = function(){mv(col=1)}
)
## Not run: 
getkpl(escape = c("escape", "enter"), fn=f, echo=FALSE)

## End(Not run)

Draw a Character Grid Matrix

Description

Constructs a grid with given dimension, character values, and step parameter, and prints it to screen

Usage

grid_at(
  yx = c(1, 1),
  dim = NULL,
  step = c(2, 2),
  text = c(".", ".", "+", "|", "|", "-", "-", rep("+", 8)),
  border = TRUE
)

Arguments

Value

NULL

See Also

Other drawing functions: box_at(), draw_arc(), draw_bezier(), draw_circle(), draw_ellipse(), draw_fn(), draw_lerp(), draw_path(), draw_ray(), draw_rect(), draw_shape(), fill_circle(), fill_ellipse(), fill_rect(), fill_shape(), grid_mat(), hline_at(), hline(), vline_at(), vline()

Examples

grid_at(yx=c(2,2), dim=c(11,13), step=c(2,4), border=TRUE)

Create a Character Grid Matrix

Description

Constructs a grid with provided dimensions (row, col), character values for gridlines, and a step parameter noting the number of rows and columns between each gridline.

Usage

grid_mat(
  dim,
  step = c(2, 2),
  text = c(".", ".", "+", "|", "|", "-", "-", rep("+", 8)),
  border = TRUE
)

Arguments

Value

rowxcol matrix

See Also

Other drawing functions: box_at(), draw_arc(), draw_bezier(), draw_circle(), draw_ellipse(), draw_fn(), draw_lerp(), draw_path(), draw_ray(), draw_rect(), draw_shape(), fill_circle(), fill_ellipse(), fill_rect(), fill_shape(), grid_at(), hline_at(), hline(), vline_at(), vline()

Examples

grid_mat(dim=c(11,13), step=c(2,4), border=TRUE)

Hide Cursor

Description

Make the cursor invisible. The cursor can be revealed with show_cursor

Usage

hide_cursor()

Value

NULL

Examples

hide_cursor()
cat("\n\nHello World!")
show_cursor()

Horizontal Line

Description

Horizontal Line

Usage

hline(n, text = "-")

Arguments

Value

character string of length n

See Also

Other drawing functions: box_at(), draw_arc(), draw_bezier(), draw_circle(), draw_ellipse(), draw_fn(), draw_lerp(), draw_path(), draw_ray(), draw_rect(), draw_shape(), fill_circle(), fill_ellipse(), fill_rect(), fill_shape(), grid_at(), grid_mat(), hline_at(), vline_at(), vline()

Examples

hline(10, "*") # **********
hline(5, "$")  # $$$$$

Draw Horizontal Line

Description

Draws a horizontal line of length n at (row, col)

Usage

hline_at(yx, n, text = "-", ...)

Arguments

Value

NULL

See Also

Other drawing functions: box_at(), draw_arc(), draw_bezier(), draw_circle(), draw_ellipse(), draw_fn(), draw_lerp(), draw_path(), draw_ray(), draw_rect(), draw_shape(), fill_circle(), fill_ellipse(), fill_rect(), fill_shape(), grid_at(), grid_mat(), hline(), vline_at(), vline()

Examples

hline_at(c(3,4),6,"-") # print "------" at (3,4)

Determine whether in Terminal

Description

Tests whether the session is in terminal and returns TRUE or FALSE. Many of the cursr functions require being in terminal and will not work with RStudio or the R GUI application.

Usage

in.term()

Value

logical value; TRUE or FALSE

Examples

in.term()

Load Cursor

Description

Restore cursor to its previously saved location from save_cursor.

Usage

load_cursor()

Value

NULL

Examples

save_cursor()
cat("\n\nHello World!")
load_cursor()

Create Background Color

Description

Returns the ANSI code for the specified background color. make_bg accepts numeric values (RGB or 8-bit color code), hexadecimal characters, or the name of the color.

Usage

make_bg(...)

Arguments

Value

ANSI character string

See Also

Other style functions: attr_off(), attr_on(), bg_off(), bg_on(), color_off(), color_pair(), fg_off(), fg_on(), make_fg(), make_style(), reset(), style()

Examples

# Different methods of specifying cyan
make_bg("cyan")
make_bg("#00FFFF")
make_bg(14)
make_bg(0, 255, 255)

Create Foreground Color

Description

Returns the ANSI code for the specified foreground color. make_fg accepts numeric values (RGB or 8-bit color code), hexadecimal characters, or the name of the color.

Usage

make_fg(...)

Arguments

Value

ANSI character string

See Also

Other style functions: attr_off(), attr_on(), bg_off(), bg_on(), color_off(), color_pair(), fg_off(), fg_on(), make_bg(), make_style(), reset(), style()

Examples

# Different methods of specifying red
make_fg("red")
make_fg("#FF0000")
make_fg(9)
make_fg(255, 0, 0)

Create Color & Attribute Style

Description

Returns the ANSI codes for the specified colors and text attributes.

Usage

make_style(fg = NA, bg = NA, attr = NA)

Arguments

Value

ANSI character string

See Also

Other style functions: attr_off(), attr_on(), bg_off(), bg_on(), color_off(), color_pair(), fg_off(), fg_on(), make_bg(), make_fg(), reset(), style()

Examples

cat(make_style(fg="blue", bg=c(192,192,192), attr=c("ul", "st")))
cat("Hello World!\n")
reset()

Move Cursor

Description

Move cursor relative to its current position on the screen. Screen coordinates are given by (row, column) with the position of the screen being (1, 1).

Usage

mv(row = 0L, col = 0L)

Arguments

Details

The user must be in a terminal to use the functionality; it will not work in RStudio or the R GUI.

Value

NULL

See Also

mv_to to move to a specific location on the screen.

Other moving functions: mv_col(), mv_row(), mv_to()

Examples

# move the cursor down one and forward two
mv(1, 2)

# Alternatively, you can specify the coordinates as a single vector.
loc <- c(1, 2)
mv(loc)

# to move to the left one unit (only works if the current column is > 1)
mv(, -1)

Move Cursor to Column

Description

Move the cursor to the specified column, while maintaining the same row.

Usage

mv_col(n = 1L)

Arguments

Details

The user must be in a terminal to use the functionality; it will not work in RStudio or the R GUI.

Value

NULL

See Also

Other moving functions: mv_row(), mv_to(), mv()

Examples

# Position cursor at the beginning of the row
mv_col(1)

# Move cursor to the 10th column in the row
mv_col(10)

Move Cursor to Row

Description

Moves cursor to the beginning of the row relative to its current location.

Usage

mv_row(n = 1L)

Arguments

Details

The user must be in a terminal to use the functionality; it will not work in RStudio or the R GUI.

Value

NULL

See Also

Other moving functions: mv_col(), mv_to(), mv()

Examples

# move the cursor to the beginning of the previous line
mv_row(-1)

Move Cursor to Specified Location

Description

Move cursor relative to its current position on the screen. Screen coordinates are given by (row, column) with the position of the screen being (1, 1).

Usage

mv_to(row = 1L, col = 1L)

Arguments

Details

The user must be in a terminal to use the functionality; it will not work in RStudio or the R GUI.

Value

NULL

See Also

mv to move relative to the current location on the screen.

Other moving functions: mv_col(), mv_row(), mv()

Examples

# move the cursor to the 2nd row, 4th column
mv_to(2, 4)

# alternatively, you can specify the coordinates as a vector.
loc <- c(2, 4)
mv_to(loc)

Arc Path

Description

Calculate the path of an arc within a grid.

Usage

path_arc(yx, start, end, r = 1, n = 50)

Arguments

Value

Nx2 matrix of (row, column) coordinates

See Also

Other path-fitting functions: path_bezier(), path_circle(), path_ellipse(), path_fill(), path_fn(), path_intersection(), path_lerp(), path_ray(), path_rect(), path_shape()

Examples

path_arc(yx=c(10,10), start=pi/2, end=pi, r=6)

Bezier Curve Path

Description

Calculate the path of a Bezier Curve with up to two control points in a grid.

Usage

path_bezier(start, end, c1, c2 = NULL, n = 50)

Arguments

Value

Nx2 matrix of (row, column) coordinates

See Also

Other path-fitting functions: path_arc(), path_circle(), path_ellipse(), path_fill(), path_fn(), path_intersection(), path_lerp(), path_ray(), path_rect(), path_shape()

Examples

path_bezier(start=c(10,1), end=c(10,10), c1=c(1, 3))

Path of a Circle

Description

Calculate the path of a circle in a grid.

Usage

path_circle(yx, r = 1, n = 50)

Arguments

Value

Nx2 matrix of (row, column) coordinates

See Also

Other path-fitting functions: path_arc(), path_bezier(), path_ellipse(), path_fill(), path_fn(), path_intersection(), path_lerp(), path_ray(), path_rect(), path_shape()

Examples

path_circle(yx=c(10,10), r=5)

Ellipse Path

Description

Calculate the path of an ellipse within a grid.

Usage

path_ellipse(yx = c(0, 0), rx = 1, ry = 1, n = 50)

Arguments

Value

Nx2 matrix of (row, column) coordinates

See Also

Other path-fitting functions: path_arc(), path_bezier(), path_circle(), path_fill(), path_fn(), path_intersection(), path_lerp(), path_ray(), path_rect(), path_shape()

Examples

path_ellipse(yx=c(10,10), rx=8, ry = 4)

Fill In Path

Description

Calculate the coordinates of all points inside of a path.

Usage

path_fill(mat)

Arguments

Value

Nx2 matrix of (row, column) coordinates

See Also

Other path-fitting functions: path_arc(), path_bezier(), path_circle(), path_ellipse(), path_fn(), path_intersection(), path_lerp(), path_ray(), path_rect(), path_shape()

Examples

c0 <- path_circle(c(10,10), r=5)
path_fill(c0)

Function Path

Description

Calculate the path within a grid of an user-supplied function.

Usage

path_fn(x1, x2, fn, n = 50)

Arguments

Value

Nx2 matrix of (row, column) coordinates

See Also

Other path-fitting functions: path_arc(), path_bezier(), path_circle(), path_ellipse(), path_fill(), path_intersection(), path_lerp(), path_ray(), path_rect(), path_shape()

Examples

path_fn(x1=1, x2=10,
  function(x){sqrt(x)}
)

Intersection between Two Paths

Description

Calculate the points of intersection between two paths.

Usage

path_intersection(path)

Arguments

Value

Nx2 matrix of (row, column) coordinates

See Also

Other path-fitting functions: path_arc(), path_bezier(), path_circle(), path_ellipse(), path_fill(), path_fn(), path_lerp(), path_ray(), path_rect(), path_shape()

Examples

c1 <- path_circle(c(4,4), r=3)
c2 <- path_circle(c(6,6), r=3)
path_intersection(list(c1, c2))

Linear Interpolation Path

Description

Interpolate between two points in a grid.

Usage

path_lerp(start, end, n = 50)

Arguments

Value

Nx2 matrix of (row, column) coordinates

See Also

Other path-fitting functions: path_arc(), path_bezier(), path_circle(), path_ellipse(), path_fill(), path_fn(), path_intersection(), path_ray(), path_rect(), path_shape()

Examples

path_lerp(start=c(10,1), end=c(1,3))

Ray Path

Description

Calculate the path of a ray extending

Usage

path_ray(start, end, lim = c(64, 128), n = 200)

Arguments

Value

Nx2 matrix of (row, column) coordinates

See Also

Other path-fitting functions: path_arc(), path_bezier(), path_circle(), path_ellipse(), path_fill(), path_fn(), path_intersection(), path_lerp(), path_rect(), path_shape()

Examples

path_ray(start=c(10,10), end=pi/6)
path_ray(start=c(10,10), end=pi/6, lim=c(15,15))
path_ray(start=c(10,10), end=c(4,2))

Rectangle Path

Description

Calculate the path of a rectangle in a grid.

Usage

path_rect(yx1, yx2)

Arguments

Value

Nx2 matrix of (row, column) coordinates

See Also

Other path-fitting functions: path_arc(), path_bezier(), path_circle(), path_ellipse(), path_fill(), path_fn(), path_intersection(), path_lerp(), path_ray(), path_shape()

Examples

path_rect(c(5,5), c(9,9))

Path along a Shape

Description

Calculate the path of a shape given supplied vertices.

Usage

path_shape(mat, cycle = TRUE, n = 30)

Arguments

Value

Nx2 matrix of (row, column) coordinates

See Also

Other path-fitting functions: path_arc(), path_bezier(), path_circle(), path_ellipse(), path_fill(), path_fn(), path_intersection(), path_lerp(), path_ray(), path_rect()

Examples

# Right Triangle
path_shape(rbind(
  c(10,1),
  c(10,10),
  c(1,1)
), cycle=TRUE)

Repeat a Character

Description

Repeat a character n times and concatenate into a single value.

Usage

repch(x, n)

Arguments

Value

character vector

Examples

repch("abc", 5)

Reset Console Style

Description

Turns off all text attributes and colors in the terminal.

Usage

reset()

Value

NULL

See Also

Other style functions: attr_off(), attr_on(), bg_off(), bg_on(), color_off(), color_pair(), fg_off(), fg_on(), make_bg(), make_fg(), make_style(), style()

Examples

attr_on("ul")
fg_on("red")
bg_on(c(10,60,205))
cat("Hello World!\n")

reset()
cat("Hello World!\n")

Save Cursor Position

Description

Save the position of the cursor so that the position can be restored for later with load_cursor.

Usage

save_cursor()

Value

NULL

Examples

save_cursor()
cat("\n\nHello World!")
load_cursor()

Show Cursor

Description

Reveal the cursor after it has been hidden by hide_cursor.

Usage

show_cursor()

Value

NULL

Examples

hide_cursor()
cat("\n\nHello World!")
show_cursor()

Add Color & Attributes to a Character

Description

Add color and other text attributes to a character vector. Attributes can be seen after text is passed to cat, though it may only show up in a terminal. Note that terminal attributes and colors are automatically reset to default after text is printed.

Usage

style(x, fg = NA, bg = NA, attr = NA)

Arguments

Value

character vector

See Also

Other style functions: attr_off(), attr_on(), bg_off(), bg_on(), color_off(), color_pair(), fg_off(), fg_on(), make_bg(), make_fg(), make_style(), reset()

Examples

x <- style("Hello World!\n", fg="blue", bg=c(192,192,192), attr=c("ul", "st"))
cat(paste(x, "It is nice to meet you!"))

Determine Terminal Size

Description

Function determines the size of the terminal in number of rows and columns. The value may not be accurate in RStudio or the R GUI.

Usage

term_dim()

Value

numeric vector (# of rows, # of columns)

Examples

term_dim()

Vertical Line

Description

Vertical Line

Usage

vline(n, text = "|")

Arguments

Value

character string of length n, separated by "\n"

See Also

Other drawing functions: box_at(), draw_arc(), draw_bezier(), draw_circle(), draw_ellipse(), draw_fn(), draw_lerp(), draw_path(), draw_ray(), draw_rect(), draw_shape(), fill_circle(), fill_ellipse(), fill_rect(), fill_shape(), grid_at(), grid_mat(), hline_at(), hline(), vline_at()

Examples

vline(4, "*") # "*\n*\n*\n*"

Draw Vertical Line

Description

Draws a vertical line of length n at (row, col)

Usage

vline_at(yx, n, text = "|", ...)

Arguments

Value

NULL

See Also

Other drawing functions: box_at(), draw_arc(), draw_bezier(), draw_circle(), draw_ellipse(), draw_fn(), draw_lerp(), draw_path(), draw_ray(), draw_rect(), draw_shape(), fill_circle(), fill_ellipse(), fill_rect(), fill_shape(), grid_at(), grid_mat(), hline_at(), hline(), vline()

Examples

vline_at(c(3,4),6,"|") # print "|" at (3,4), ..., (8,4)

Write String to Terminal

Description

Writes a string of characters to the terminal at the current cursor position. wr accepts text colors and attributes, but these are reset to default afterwards if used.

Usage

wr(text, fg = NA, bg = NA, attr = NA)

Arguments

Value

NULL

See Also

Other writing functions: wrat(), wrch(), wrkpl(), wrkp()

Examples

mv_to(5,4)
wrch("h")
wrch("e", fg="red")
wr("llo World")

Return Screen to Blank State

Description

Function to be used at the end of a terminal function. It resets the colors and attributes to their default values, clears the screen, and reveals the cursor.

Usage

wrapup()

Value

NULL

Write At a Specific Location

Description

Move cursor to specified location in the terminal screen, then print the supplied text. This function will only work in terminal, not the RStudio Console or R GUI.

Usage

wrat(yx, text, ...)

Arguments

Details

The coordinates are given in matrix notation: (row, column), with the top-left corner of the screen being (1,1).

Value

NULL

See Also

Other writing functions: wrch(), wrkpl(), wrkp(), wr()

Examples

wrat(c(10,6), "CURSR")
wrat(c(4,1), "Hello World!", fg="red", attr=c("bf", "ul"))

mat <- rbind(c(5,2), c(10,5), c(1,19))
wrat(mat, "HI", fg="yellow")

Write Character to Terminal

Description

Writes a single character to the terminal at the current cursor position. wr accepts text colors and attributes, but these are reset to default afterwards if used.

Usage

wrch(chr, fg = NA, bg = NA, attr = NA)

Arguments

Value

NULL

See Also

Other writing functions: wrat(), wrkpl(), wrkp(), wr()

Examples

mv_to(5,4)
wrch("h")
wrch("e", fg="red")
wr("llo World")

Write Character to Terminal at Specified Location

Description

Move cursor to specified location in the terminal screen, then print the supplied character. This function will only work in terminal, not the RStudio Console or R GUI.

Usage

wrchat(row, col, chr, ...)

Arguments

Details

The coordinates are given in matrix notation: (row, column), with the top-left corner of the screen being (1,1).

Value

NULL

Examples

wrchat(5, 4, "h")

Echo Keypress to Screen

Description

Detect keypress and print it to the terminal screen, while invisibly returning the keypress. The user can specify which characters to ignore, and can also map keys to a list of functions. Any keypress mapped to a function will not be echoed to the screen.

Usage

wrkp(ignore = "escape", fn = list(), ...)

Arguments

Value

NULL

See Also

Other writing functions: wrat(), wrch(), wrkpl(), wr()

Examples

## Not run: 
wrkp(
 ignore="escape",
 fn = list(
   enter = function(){mv_row(1)},
   left = function(){mv(0, -1)},
   right = function(){mv(0, 1)},
   up = function(){mv(-1,0)},
   down = function(){mv(1,0)},
   space = function(){cat(" ")}
 )
)

## End(Not run)

Echo Keypress to Screen in a Loop

Description

Detect keypress and print it to the terminal screen, while invisibly returning the keypress. The user can specify which characters to ignore, and can also map keys to a list of functions. Any keypress mapped to a function will not be echoed to the screen.

Usage

wrkpl(escape = c("escape"), ignore = NA_character_, fn = list(), ...)

Arguments

Value

NULL

See Also

Other writing functions: wrat(), wrch(), wrkp(), wr()

Examples

## Not run: 
wrkpl(
  escape = "escape",
  fn = list(
    enter = function(){mv_row(1)},
    left = function(){mv(0, -1)},
    right = function(){mv(0, 1)},
    up = function(){mv(-1,0)},
    down = function(){mv(1,0)},
    space = function(){cat(" ")}
  )
)

## End(Not run)