Package {ggdiagram}

Title:	Object-Oriented Diagram Plots with 'ggplot2'
Version:	0.2.0
Description:	Creates diagrams with an object-oriented approach. Geometric objects have computed properties with information about themselves (e.g., their area) or about their relationships with other objects (e.g, the distance between their edges). The objects have methods to convert them to geoms that can be plotted in 'ggplot2'.
License:	CC0
URL:	https://github.com/wjschne/ggdiagram, https://wjschne.github.io/ggdiagram/
BugReports:	https://github.com/wjschne/ggdiagram/issues
Depends:	R (≥ 4.1.0)
Imports:	arrowheadr, bezier, cli, dplyr, farver, geomtextpath, ggarrow, ggforce (≥ 0.5.0), ggplot2 (≥ 4.0.0), ggtext, grDevices, grid, janitor, lavaan, magick, magrittr, pdftools, purrr, rlang, S7, scales, signs, stringr, tibble, tidyr, tinter, tinytex, utils, vctrs
Suggests:	knitr, marquee, methods, quarto, rmarkdown, simstandard, spelling, svglite, testthat (≥ 3.0.0), tidyverse, viridis, withr
VignetteBuilder:	knitr, quarto
Config/Needs/website:	quarto
Config/roxygen2/markdown:	TRUE
Config/roxygen2/version:	8.0.0
Config/testthat/edition:	3
Encoding:	UTF-8
Language:	en-US
RoxygenNote:	8.0.0
Collate:	'ggdiagram-package.R' 'utils-pipe.R' 'a_early.R' 'str.R' 'colors.R' 'angles.R' 'style.R' 'points.R' 'labels.R' 'lines.R' 'segments.R' 'paths.R' 'circles.R' 'ellipses.R' 'arcs.R' 'bezier.R' 'rectangles.R' 'polygons.R' 'equations.R' 'distances.R' 'intersections.R' 'inside.R' 'rotate.R' 'rescale.R' 'zzz.R'
NeedsCompilation:	no
Packaged:	2026-05-23 12:44:31 UTC; tuh42402
Author:	W. Joel Schneider [aut, cre]
Maintainer:	W. Joel Schneider <w.joel.schneider@gmail.com>
Repository:	CRAN
Date/Publication:	2026-05-23 13:20:02 UTC

ggdiagram: Object-Oriented Diagram Plots with 'ggplot2'

Description

Creates diagrams with an object-oriented approach. Geometric objects have computed properties with information about themselves (e.g., their area) or about their relationships with other objects (e.g, the distance between their edges). The objects have methods to convert them to geoms that can be plotted in 'ggplot2'.

Author(s)

Maintainer: W. Joel Schneider w.joel.schneider@gmail.com (ORCID)

Authors:

• W. Joel Schneider w.joel.schneider@gmail.com (ORCID)

See Also

Useful links:

• https://github.com/wjschne/ggdiagram

• https://wjschne.github.io/ggdiagram/

• Report bugs at https://github.com/wjschne/ggdiagram/issues

Pipe operator

Description

See magrittr::%>% for details.

Usage

lhs %>% rhs

Arguments

Value

The result of calling rhs(lhs).

Return default arrowhead

Description

The arrowhead function returns the default arrowhead. The set_default_arrowhead function will change the default arrowhead in the current R session. For details about making arrowheads, see the ggarrow and arrowheadr packages.

Usage

arrowhead()

set_default_arrowhead(m = NULL)

Arguments

Value

2-column matrix

previous default arrowhead

Examples

arrowhead()
# Set new default
set_default_arrowhead(ggarrow::arrow_head_wings(offset = 25))
arrowhead()
# restore default
set_default_arrowhead()
arrowhead()

as.geom function

Description

Converts a ggdiagram shape to a ggplot2 geom

Usage

as.geom(x, ...)

Arguments

Details

Usually the as.geom function is not necessary to call explicitly because it is called whenever a ggdiagram shape is added to a ggplot. However, in complex situations (e.g., making a function that assembles many objects), it is sometimes necessary to make the call explicitly.

Value

geom

Examples

library(ggplot2)
c1 <- ob_circle(radius = 3)
ggplot() +
  as.geom(c1, fill = "black") +
  coord_equal()

bind method

Description

bind method

Usage

bind(x, ...)

Arguments

Value

a bound object of same class as x (or list of objects if x contains objects of different types)

Examples

bind(c(ob_point(1,2), ob_point(3,4)))
bind(c(ob_circle(ob_point(0,0), radius = 1),
       ob_circle(ob_point(1,1), radius = 2)))

Get a circle from 3 points

Description

Get a circle from 3 points

Usage

circle_from_3_points(p1, p2 = NULL, p3 = NULL, ...)

Arguments

Value

ob_point object

Examples

circle_from_3_points(ob_point(1,1),
                     ob_point(2,4),
                     ob_point(5,3))

class_aesthetics_list

Description

list of aesthetics

Usage

class_aesthetics_list(
  geom = function() NULL,
  style = character(0),
  mappable_bare = character(0),
  mappable_identity = character(0),
  not_mappable = character(0),
  required_aes = character(0),
  omit_names = character(0),
  inherit.aes = logical(0)
)

Arguments

Value

a class_aesthetics_list object

color class

Description

Useful for manipulating colors in R.

Usage

class_color(
  color = character(0),
  hue = NULL,
  saturation = NULL,
  brightness = NULL,
  alpha = NULL,
  id = character(0)
)

Arguments

Value

class_color object

Additional properties

@transparentize

function to return the color with a new transparency (i.e., alpha)

@lighten

function to return a lighter color

@darken

function to return a darker color

@red

Gets or sets red component of rgb color

@green

Gets or sets green component of rgb color

@blue

Gets or sets blue component of rgb color

@mean

Averages the rbga components of the colors

@tex

Gets the TeX code for the color

Examples

mycolor <- class_color("blue")
mycolor
# Display html hexcode
c(mycolor)
# Set transparency
mycolor@transparentize(.5)
# Lighten color
mycolor@lighten(.5)
# Darken color
mycolor@darken(.5)

Create a structure for label margins and label padding

Description

Create a structure for label margins and label padding

Usage

class_margin(x = numeric(0), units = "pt")

Arguments

Arrow connect one shape to another

Description

By default, will create an ob_segment with an arrowhead on the end. If arc_bend is specified, an ob_arc with an arrowhead will be created instead. If from_offset or to_offset are specified, an ob_bezier with an arrowhead will be created.

Usage

connect(
  from,
  to,
  ...,
  label = character(0),
  arc_bend = NULL,
  from_offset = NULL,
  to_offset = NULL,
  alpha = numeric(0),
  arrow_head = the$arrow_head,
  arrow_fins = list(),
  arrowhead_length = 7,
  length_head = numeric(0),
  length_fins = numeric(0),
  color = character(0),
  lineend = numeric(0),
  linejoin = numeric(0),
  linewidth = numeric(0),
  linewidth_fins = numeric(0),
  linewidth_head = numeric(0),
  linetype = numeric(0),
  resect = numeric(0),
  resect_fins = numeric(0),
  resect_head = numeric(0),
  stroke_color = character(0),
  stroke_width = numeric(0),
  style = S7::class_missing,
  label_sloped = TRUE,
  id = character(0)
)

Arguments

Value

ob_segment

Make shapes from data

Description

Allows a data.frame or tibble to be converted to shape objects.

Usage

data2shape(data, shape)

Arguments

Value

shape object

Examples

d <- data.frame(
  x = 1:2,
  y = 1:2,
  fill = c("blue", "forestgreen"),
  color = NA,
  radius = c(.25,0.5))

data2shape(d, ob_circle)

Calculate distance between 2 points

Description

Calculate distance between 2 points

Usage

distance(x, y, ...)

Arguments

Value

numeric

Examples

# Distance between two objects
p1 <- ob_point(0, 0)
p2 <- ob_point(3, 4)
distance(p1, p2)

# Distance between the endpoints of a segment
s1 <- ob_segment(p1, p2)
distance(s1)

# Distance between a point and a line
l1 <- ob_line(slope = 0, intercept = 1)
distance(p1, l1)

# Shortest distance between the edges of 2 circles
c1 <- ob_circle(p1, radius = 1)
c2 <- ob_circle(p2, radius = 2)
distance(c1, c2)

equation

Description

Get equation for object

Usage

equation(
  x,
  type = c("y", "general", "parametric"),
  output = c("markdown", "latex"),
  digits = 2
)

Arguments

Value

string

Examples

l1 <- ob_line(slope = 2, intercept = 4)
c1 <- ob_circle(radius = 3)
equation(c1)
equation(l1)

Function to calculate hierarchy depth in lavaan models

Description

Function to calculate hierarchy depth in lavaan models

Usage

get_depth(x, model, depth = 0L, max_depth = 20)

Arguments

Value

integer

Examples

model <- "X =~ X1 + X2"
get_depth("X", model = model)
get_depth("X1", model = model)

Get object data with styles in a tibble

Description

Get object data with styles in a tibble

Get object data in a tibble, filling in any missing styles with defaults

Usage

get_tibble(x)

get_tibble_defaults(x)

Arguments

Value

a tibble::tibble

a tibble::tibble

ggdiagram function

Description

This is a convenient way to specify geom defaults

Usage

ggdiagram(
  font_family = "sans",
  font_size = 11,
  linewidth = 0.5,
  point_size = 1.5,
  rect_linewidth = linewidth,
  theme_function = ggplot2::theme_void,
  ...
)

Arguments

Value

ggplot function

Examples

ggdiagram(font_size = 20, font_family = "serif", linewidth = 3) +
   ob_circle(label = "Circle") +
   ob_rectangle(label = "Rectangle", x = 3, width = 3)

is an ob_point inside a shape ?

Description

is an ob_point inside a shape ?

Usage

inside(x, y)

Arguments

Value

numeric vector where 1 = inside, 0 = on, -1 = outside

intersection of 2 objects (e.g., lines)

Description

intersection of 2 objects (e.g., lines)

Usage

intersection(x, y, ...)

Arguments

Value

shape object

Compute the angle of the intersection of two objects

Description

Compute the angle of the intersection of two objects

Usage

intersection_angle(x, y)

Arguments

Value

ob_angle object

Automatic label for objects

Description

Automatic label for objects

Usage

label_object(object, ...)

Arguments

Value

string

Surround TeX expression with a color command

Description

Surround TeX expression with a color command

Usage

latex_color(x, color)

Arguments

Value

string

Examples

latex_color("X^2", "red")

Finds the "previous" (lag) or "next" (lead) values in a vector or object with values at the end of the vector recycled to the beginning.

Description

Finds the "previous" (lag) or "next" (lead) values in a vector or object with values at the end of the vector recycled to the beginning.

Usage

lead_cycle(x, n = 1L)

lag_cycle(x, n = 1L)

Arguments

Value

A vector with the same type and size as x but with elements shifted and cycled by n.

Examples

lead_cycle(1:5)
lead_cycle(1:5, 2)
lag_cycle(1:5)
lag_cycle(1:5, 2)

Map over two ggdiagram objects

Description

A wrapper for purrr::map2. It takes two ggdiagram objects with multiple elements, applies a function to each element within the objects, and returns a ggdiagram object

Usage

map2_ob(.x, .y, .f, ..., .progress = FALSE)

Arguments

Value

a ggdiagram object

Map over a ggdiagram object

Description

A wrapper for purrr::map. It takes a ggdiagram object with multiple elements, applies a function to each element within the object, and returns a ggdiagram object

Usage

map_ob(.x, .f, ..., .progress = FALSE)

Arguments

Value

a ggdiagram object

Average across colors

Description

Average across colors

Usage

mean_color(x)

Arguments

Value

string

Examples

color_A <- "dodgerblue"
color_B <- "violet"
mean_color(c(color_A, color_B))

Get one or more points at positions from 0 to 1

Description

It is possible to get more than one midpoint by specifying a position vector with a length greater than 1. Position values outside 0 and 1 will usually work, but will be outside the object.

Usage

midpoint(x, y, position = 0.5, ...)

Arguments

Value

ob_point

Move an object

Description

Move an object

Usage

nudge(object, x, y, ...)

Arguments

Value

object of same class as object

Examples

ob_circle() |> nudge(x = 2)
# Alternative to nudge:
ob_circle() + ob_point(2, 0)

ob_angle

Description

Creates an angle in the metric of radians, degrees, and turns.

Usage

ob_angle(
  .data = numeric(0),
  degree = numeric(0),
  radian = numeric(0),
  turn = numeric(0)
)

degree(degree = numeric(0))

radian(radian = numeric(0))

turn(turn = numeric(0))

Arguments

Details

Angles turns can be any real number, but degrees are displayed as values between -360 and +360, and radians are between -2pi and +2pi.

Value

ob_angle

Additional properties

@positive

if angle is negative, adds a full turn to ensure the angle is positive

@negative

if angle is positive, subtracts a full turn to ensure the angle is negative

@upright

Converts angle to an "upright" position so that text is never upside down (i.e., 91–270 degrees is flipped to )

Examples

# Three Different ways to make a right angle
## 90 degrees
degree(90)

## half pi radians
radian(.5 * pi)

## A quarter turn
turn(.25)

# Operations
degree(30) + degree(20)
degree(350) + degree(20)
degree(30) - degree(30)
degree(30) - degree(50)

degree(30) * 2
degree(30) / 3

radian(1) + 1 # added or subtracted numbers are radians
degree(10) + 10 # added or subtracted numbers are degrees
turn(.25) + .25 # added or subtracted numbers are turns

# Trigonometric functions work as normal
sin(degree(30))
cos(degree(30))
tan(degree(30))

ob_arc class

Description

Create arcs and wedges

Usage

ob_arc(
  center = ob_point(0, 0),
  radius = 1,
  start = 0,
  end = 0,
  label = character(0),
  label_sloped = FALSE,
  start_point = S7::class_missing,
  end_point = S7::class_missing,
  n = 360L,
  type = "arc",
  alpha = numeric(0),
  arrow_head = list(),
  arrow_fins = list(),
  arrowhead_length = numeric(0),
  length_head = numeric(0),
  length_fins = numeric(0),
  color = character(0),
  fill = character(0),
  lineend = numeric(0),
  linejoin = numeric(0),
  linewidth = numeric(0),
  linewidth_fins = numeric(0),
  linewidth_head = numeric(0),
  linetype = numeric(0),
  resect = numeric(0),
  resect_fins = numeric(0),
  resect_head = numeric(0),
  stroke_color = character(0),
  stroke_width = numeric(0),
  style = S7::class_missing,
  x = numeric(0),
  y = numeric(0),
  id = character(0),
  ...
)

ob_wedge(
  center = ob_point(0, 0),
  radius = 1,
  start = 0,
  end = 0,
  label = character(0),
  label_sloped = FALSE,
  start_point = S7::class_missing,
  end_point = S7::class_missing,
  n = 360L,
  type = "wedge",
  alpha = numeric(0),
  arrow_head = list(),
  arrow_fins = list(),
  arrowhead_length = numeric(0),
  length_head = numeric(0),
  length_fins = numeric(0),
  color = NA,
  fill = "black",
  lineend = numeric(0),
  linejoin = numeric(0),
  linewidth = numeric(0),
  linewidth_fins = numeric(0),
  linewidth_head = numeric(0),
  linetype = numeric(0),
  resect = numeric(0),
  resect_fins = numeric(0),
  resect_head = numeric(0),
  stroke_color = character(0),
  stroke_width = numeric(0),
  style = S7::class_missing,
  x = numeric(0),
  y = numeric(0),
  id = character(0),
  ...
)

ob_circular_segment(
  center = ob_point(0, 0),
  radius = 1,
  start = 0,
  end = 0,
  label = character(0),
  label_sloped = FALSE,
  start_point = S7::class_missing,
  end_point = S7::class_missing,
  n = 360L,
  type = "segment",
  alpha = numeric(0),
  arrow_head = list(),
  arrow_fins = list(),
  arrowhead_length = numeric(0),
  length_head = numeric(0),
  length_fins = numeric(0),
  color = NA,
  fill = "black",
  lineend = numeric(0),
  linejoin = numeric(0),
  linewidth = numeric(0),
  linewidth_fins = numeric(0),
  linewidth_head = numeric(0),
  linetype = numeric(0),
  resect = numeric(0),
  resect_fins = numeric(0),
  resect_head = numeric(0),
  stroke_color = character(0),
  stroke_width = numeric(0),
  style = S7::class_missing,
  x = numeric(0),
  y = numeric(0),
  id = character(0),
  ...
)

Arguments

Value

ob_arc object

Additional properties

@aesthetics

A list of information about the arc's aesthetic properties

@angle_at

A function that finds the angle of the specified point in relation to the arc's center

@apothem

Distance from center to the chord's midpoint

@arc_length

Distance along arc from start_point to end_point

@auto_label

Places an label at the arc's midpoint

@bounding_box

A rectangle that contains all the arcs

@chord

ob_segment from start_point to end_point

@circle

Circle object associated with the arc object

@geom

A function that converts the object to a geom. Any additional parameters are passed to ggarrow::geom_arrow.

@hatch

A function that puts hatch (tally) marks on arcs. Often used to indicate which arcs have the same angle. The k parameter controls how many hatch marks to display. The height parameter controls how long the hatch mark segment is. The sep parameter controls the separation between hatch marks when k > 2. Additional parameters sent to ob_segment.

@length

The number of arcs in the arc object

@midpoint

A function that selects 1 or more midpoints of the ob_arc. The position argument can be between 0 and 1. Additional arguments are passed to ob_point.

@point_at

A function that finds a point on the arc at the specified angle.

@polygon

A tibble containing information to create all the polygon points in an arc

@sagitta

ob_segment from chord midpoint to ob_arc midpoint

@set_label_x

A function that sets labels to have the same x coordinate. The position argument can be between 0 and 1, indicating how far along on the first arc the x coordinate is selected. If the x argument is set, the position argument is overridden, and the x-coordinate is set directly.

@set_label_y

A function that sets labels to have the same y coordinate. The position argument can be between 0 and 1, indicating how far along on the first arc the y coordinate is selected. If the y argument is set, the position argument is overridden, and the y-coordinate is set directly.

@tangent_at

A function that finds the tangent line at the specified angle.

@theta

Interior angle (end - start)

@tibble

Gets a tibble::tibble or data.frame containing parameters and styles used by ggarrow::geom_arrow.

Examples

ob_arc(start = degree(0), end = degree(60))
ob_circular_segment(start = degree(120), end = degree(180))
ob_wedge(start = degree(240), end = degree(300))

Object Arrays

Description

Make an array of shapes along a line

Usage

ob_array(x, k = 2, sep = 1, where = "east", anchor = "center", ...)

Arguments

Value

An array of shapes of the same class as object passed to x

Methods

ob_array is an S7 generic with methods available for the following classes:

• ggdiagram::ob_circle

• ggdiagram::ob_ellipse

• ggdiagram::ob_point

• ggdiagram::ob_rectangle

The ob_bezier (i.e., bezier curve) class

Description

The ob_bezier is specified with an ob_point object that contains at least 2 points, the start and the end. Such a "curve" would actually be a straight line segment. If three points are specified, the middle point is a control point, and a quadratic bezier curve will result. Higher-order bezier curves can be created by having more control points in the middle.

Usage

ob_bezier(
  p = S7::class_missing,
  label = character(0),
  label_sloped = TRUE,
  n = 101,
  alpha = numeric(0),
  arrow_head = S7::class_missing,
  arrow_fins = S7::class_missing,
  arrowhead_length = numeric(0),
  length_head = numeric(0),
  length_fins = numeric(0),
  color = character(0),
  fill = character(0),
  lineend = numeric(0),
  linejoin = numeric(0),
  linewidth = numeric(0),
  linewidth_fins = numeric(0),
  linewidth_head = numeric(0),
  linetype = numeric(0),
  resect = numeric(0),
  resect_fins = numeric(0),
  resect_head = numeric(0),
  stroke_color = character(0),
  stroke_width = numeric(0),
  style = S7::class_missing,
  id = character(0),
  ...
)

Arguments

Details

If you wish to specify multiple bezier curves, you must supply a list of ob_point objects. When plotted, the ob_bezier function uses the bezier::bezier function to create the point coordinates of the curve and the ggarrow::geom_arrow function to create the geom.

Value

ob_bezier object

Additional properties

@aesthetics

A list of information about the object's aesthetic properties

@bounding_box

A rectangle that contains all the bezier curves

@geom

A function that converts the object to a geom. Any additional parameters are passed to ggarrow::geom_arrow.

@length

The number of curves in the ob_bezier object

@midpoint

A function that selects 1 or more midpoints of the ob_bezier. The position argument can be between 0 and 1. Additional arguments are passed to ob_point.

@path

A path object consisting of the control points

@point_at_x

A function that finds the point on each curve where x is equal to the x argument.

@point_at_y

A function that finds the point on each curve where y is equal to the y argument.

@set_label_x

A function that sets labels to have the same x coordinate. The position argument can be between 0 and 1, indicating how far along on the first curve the x coordinate is selected. If the x argument is set, the position argument is overridden, and the x-coordinate is set directly.

@set_label_y

A function that sets labels to have the same y coordinate. The position argument can be between 0 and 1, indicating how far along on the first curve the y coordinate is selected. If the y argument is set, the position argument is overridden, and the y-coordinate is set directly.

@tibble

Gets a tibble (data.frame) containing parameters and styles used by ggarrow::geom_arrow.

Examples

control_points <- ob_point(c(0,1,2,4), c(0,4,0,1))
ob_bezier(control_points, color = "blue")

ob_circle class

Description

ob_circle class

Usage

ob_circle(
  center = ob_point(0, 0),
  radius = 1,
  label = character(0),
  alpha = numeric(0),
  color = character(0),
  fill = character(0),
  linewidth = numeric(0),
  linetype = numeric(0),
  n = numeric(0),
  style = S7::class_missing,
  x = numeric(0),
  y = numeric(0),
  id = character(0),
  ...
)

Arguments

Value

ob_circle object

Additional properties

@aesthetics

A list of information about the circle's aesthetic properties

@angle_at

A function that finds the angle of the specified point in relation to the circle's center

@arc

A function that creates an arc object with the same center as the circle object. Must specify the start angle and the end angle. In addition, any of the parameters of ob_arc can be applied.

@area

area of the circle

@bounding_box

A rectangle that contains all the circles

@circumference

Circumference of the circle

@diameter

The diameter of the circle

@geom

A function that converts the object to a geom. Any additional parameters are passed to ggforce::geom_circle.

@length

The number of circles in the circle object

@normal_at

A function that finds a point that is perpendicular from the circle and at a specified distance

@point_at

A function that finds a point on the circle at the specified angle

@polar_line_at

A function that creates an ob_line that passes through the circle's center and the point specified in x

@polygon

A tibble containing information to create all the polygon points in a circle

@tangent_at

A function that finds the tangent line at the specified angle

@tibble

Gets a tibble (data.frame) containing parameters and styles used by ggforce::geom_circle

@east

ob_point at rightmost point of circle

@north

ob_point at highest point of circle

@west

ob_point at leftmost point of circle

@south

ob_point at lowest point of circle

@northeast

ob_point at top-right point of circle

@northwest

ob_point at top-left point of circle

@southwest

ob_point at bottom-left point of circle

@southeast

ob_point at bottom-right point of circle

Examples

# specify center point and radius
ob_circle(center = ob_point(0,0), radius = 6)

Covariance object

Description

Creates double-headed arrow paths indicating variance

Usage

ob_covariance(
  x,
  y,
  where = NULL,
  bend = 0,
  looseness = 1,
  arrow_head = the$arrow_head,
  length_head = 7,
  length_fins = 7,
  resect = 2,
  ...
)

## S7 method for classes <ggdiagram::centerpoint>, <ggdiagram::centerpoint>
ob_covariance(
  x,
  y,
  where = NULL,
  bend = 0,
  looseness = 1,
  arrow_head = the$arrow_head,
  length_head = 7,
  length_fins = 7,
  resect = 2,
  ...
)

Arguments

Value

An ob_bezier object

Methods

ob_covariance is an S7 generic with methods available for the following classes:

• ggdiagram::centerpoint,ggdiagram::centerpoint

• ggdiagram::ob_point,ggdiagram::ob_point

Examples

ggdiagram() +
  {x <- ob_circle(ob_point(c(-2, 2), 0))} +
  ob_covariance(x = x[1],
                y = x[2],
                label = ob_label("A"))

ob_ellipse class

Description

Makes ellipses and superellipses

Usage

ob_ellipse(
  center = ob_point(0, 0),
  a = 1,
  b = a,
  angle = 0,
  m1 = numeric(0),
  m2 = numeric(0),
  label = character(0),
  alpha = numeric(0),
  color = character(0),
  fill = character(0),
  linewidth = numeric(0),
  linetype = numeric(0),
  n = numeric(0),
  style = S7::class_missing,
  x = numeric(0),
  y = numeric(0),
  id = character(0),
  ...
)

Arguments

Value

ob_ellipse object

Additional properties

@aesthetics

A list of information about the object's aesthetic properties

@angle_at

A function that finds the angle of the specified point in relation to the ellipse's center

@area

area of the ellipse

@bounding_box

a rectangle that contains all the ellipses

@focus_1

left focus point of the ellipse

@focus_2

right focus point of the ellipse

@geom

A function that converts the object to a geom. Any additional parameters are passed to ggforce::geom_ellipse.

@length

Gets the number of ellipses

@normal_at

A function that finds a point perpendicular to the ellipse at angle theta at the specified distance. The definitional parameter is passed to the point_at function. If a point is supplied instead of an angle, the point is projected onto the ellipse and then the normal is calculated found from the projected point.

@perimeter

returns the ellipse's perimeter

@point_at

A function that finds a point on the ellipse at an angle theta. If definitional is FALSE (default), then theta is interpreted as an angle. If TRUE, then theta is the parameter in the definition of the ellipse in polar coordinates.

@polar_line_at

A function that creates an ob_line that passes through the ellipse's center and the point specified in x.

@polygon

a tibble containing information to create all the polygon points in ellipse.

@tangent_at

A function that finds a tangent line on the ellipse. Uses point_at to find the tangent point at angle theta and then returns the tangent line at that point. If a point is supplied instead of an angle, the point is projected onto the ellipse and then the tangent line is found from there.

@tibble

Gets a tibble (data.frame) containing parameters and styles used by ggforce::geom_ellipse.

Examples

# specify center point and semi-major axes
ob_ellipse(center = ob_point(0,0), a = 2, b = 3)

ob_intercept

Description

Triangle polygons used in path diagrams.

Usage

ob_intercept(
  center = ob_point(0, 0),
  width = 1,
  label = character(0),
  vertex_radius = numeric(0),
  alpha = numeric(0),
  color = character(0),
  fill = character(0),
  linewidth = numeric(0),
  linetype = numeric(0),
  style = S7::class_missing,
  x = numeric(0),
  y = numeric(0),
  id = character(0),
  ...
)

Arguments

Value

ob_polygon object

Additional properties

@top

Top vertex of triangle

@left

Left vertex of triangle

@right

Right vertex of triangle

@length

The number of polygons in the ob_polygon object

@aesthetics

A list of information about the object's aesthetic properties

@tibble

Gets a tibble (data.frame) containing parameters and styles used by ggplot2::geom_polygon.

ob_label class

Description

ob_label class

Usage

ob_label(
  label = character(0),
  center = S7::class_missing,
  angle = numeric(0),
  alpha = numeric(0),
  color = character(0),
  family = character(0),
  fill = character(0),
  fontface = character(0),
  hjust = numeric(0),
  label.color = character(0),
  label.margin = class_margin(ggplot2::margin(1, 1, 1, 1, "pt")),
  label.padding = class_margin(ggplot2::margin(2, 2, 2, 2, "pt")),
  label.r = numeric(0),
  label.size = numeric(0),
  lineheight = numeric(0),
  polar_just = numeric(0),
  nudge_x = numeric(0),
  nudge_y = numeric(0),
  size = numeric(0),
  straight = logical(0),
  text.color = character(0),
  vjust = numeric(0),
  style = S7::class_missing,
  plot_point = FALSE,
  position = 0.5,
  spacing = numeric(0),
  x = S7::class_missing,
  y = S7::class_missing,
  id = character(0),
  ...
)

Arguments

Value

ob_label object

Additional properties

@aesthetics

A list of information about the label's aesthetic properties

@auto_label

Places a label of the xy coordinates (e.g., ⁠(0, 1)⁠)

@geom

A function that converts the object to a geom. Any additional parameters are passed to ggtext::geom_richtext.

@tibble

Gets a tibble (data.frame) containing parameters and styles used by ggtext::geom_richtext

@xy

Gets a 2-column matrix of the x and y coordinates of the label's center

ob_latex class

Description

make a latex equation

Usage

ob_latex(
  tex = character(0),
  center = ob_point(0, 0),
  width = numeric(0),
  height = numeric(0),
  hjust = 0.5,
  vjust = 0.5,
  angle = 0,
  aspect_ratio = 1,
  border = numeric(0),
  family = character(0),
  math_mode = TRUE,
  filename = character(0),
  color = character(0),
  fill = "white",
  density = 300,
  latex_packages = character(0),
  preamble = character(0),
  force_recompile = TRUE,
  delete_files = TRUE,
  id = character(0)
)

Arguments

Value

ob_latex object

Additional properties

@rectangle

gets or sets rectangle that contains the image

@image

raster bitmap

ob_line class

Description

Creates a line

Usage

ob_line(
  slope = numeric(0),
  intercept = numeric(0),
  xintercept = numeric(0),
  a = numeric(0),
  b = numeric(0),
  c = numeric(0),
  alpha = numeric(0),
  color = character(0),
  lineend = numeric(0),
  linejoin = numeric(0),
  linewidth = numeric(0),
  linetype = numeric(0),
  style = S7::class_missing,
  id = character(0),
  ...
)

Arguments

Value

ob_line object

Additional properties

@aesthetics

A list of information about the circle's aesthetic properties

@angle

The angle of the line

@equation

Returns a character string with the equation for the line

@geom

A function that converts the object to a geom. Any additional parameters are passed to ggplot2::geom_line.

@length

The number of lines in the line object

@point_at_x

A function that finds the point on each line where x is equal to the x argument

@point_at_y

A function that finds the point on each line where y is equal to the y argument

@projection

A function that returns the projected point from the point object specified in p

@tibble

Returns a tibble (data frame) with object parameters, one row for each line in the line object

The ob_ngon (regular polygon) class

Description

An ngon is a regular polygon, meaning that each side is of equal length. The ob_ngon object can be specified with a center, n (number of sides), radius, and angle. Instead of specifying a radius, one can specify either the side_length or the length of the apothem (i.e., the distance from the center to a side's midpoint.

Usage

ob_ngon(
  center = ob_point(0, 0),
  n = 3L,
  radius = numeric(0),
  angle = 0,
  label = character(0),
  side_length = numeric(0),
  apothem = numeric(0),
  vertex_radius = numeric(0),
  alpha = numeric(0),
  color = character(0),
  fill = character(0),
  linewidth = numeric(0),
  linetype = numeric(0),
  style = S7::class_missing,
  x = numeric(0),
  y = numeric(0),
  id = character(0),
  ...
)

Arguments

Value

ob_ngon object

Additional properties

@aesthetics

A list of information about the object's aesthetic properties

@area

The area of the ngons in the ob_ngon object

@bounding_box

a rectangle that contains all the ngons

@circumscribed

Returns the circle that circumscribes the ngon.

@inscribed

Returns the circle that inscribes the ngon.

@length

The number of ngons in the ob_ngon object

@normal_at

A function that finds a point that is perpendicular from the ngon and at a specified distance

@perimeter

The length of the sum of all the side segments

@point_at

A function that finds a point on the ngon at the specified angle.

@segments

side segments of the regular polygon

@tangent_at

A function that finds the tangent line at the specified angle.

@tibble

Gets a tibble (data.frame) containing parameters and styles used by ggforce::geom_shape.

@vertices

points on the regular polygon

@east

right point (ob_point)

@north

top point (ob_point)

@west

left point (ob_point)

@south

top point (ob_point)

@northeast

upper right point (ob_point)

@northwest

upper left point (ob_point)

@southwest

lower left point (ob_point)

@southeast

lower right point (ob_point)

Examples

ob_ngon(center = ob_point(x = 3:8, y = 0),
        n = 3:8,
        radius = .4)

The ob_path class

Description

An ob_path is specified with an ob_point object that contains at least 2 points, the start and the end. Any number of intermediate points are possible.

Usage

ob_path(
  p = S7::class_missing,
  label = character(0),
  label_sloped = TRUE,
  alpha = numeric(0),
  arrow_head = S7::class_missing,
  arrow_fins = S7::class_missing,
  arrowhead_length = numeric(0),
  length_head = numeric(0),
  length_fins = numeric(0),
  color = character(0),
  fill = character(0),
  lineend = numeric(0),
  linejoin = numeric(0),
  linewidth = numeric(0),
  linewidth_fins = numeric(0),
  linewidth_head = numeric(0),
  linetype = numeric(0),
  resect = numeric(0),
  resect_fins = numeric(0),
  resect_head = numeric(0),
  stroke_color = character(0),
  stroke_width = numeric(0),
  style = S7::class_missing,
  id = character(0),
  ...
)

Arguments

Details

If you wish to specify multiple paths, you must supply a list of ob_point objects. When plotted, the ob_path function uses the ggarrow::geom_arrow function to create the geom.

Value

ob_path object

Additional properties

@aesthetics

A list of information about the path's aesthetic properties

@bounding_box

A rectangle that contains all the paths

@geom

A function that converts the object to a geom. Any additional parameters are passed to ggarrow::geom_arrow.

@length

The number of paths in the ob_path object

@midpoint

A function that selects 1 or more midpoints of the ob_segment. The position argument can be between 0 and 1. Additional arguments are passed to ob_point.

@tibble

Gets a tibble::tibble containing parameters and styles used by ggarrow::geom_arrow.

@segments

Gets the segments from the path

@vertex_angle

Gets angles at each vertex

Examples

ggdiagram() +
 ob_path(list(ob_point(c(0, 0, 4), c(0, 1, 4)),
              ob_point(c(1, 2, 5, 6), c(0, 1, 2, 0))), color = c("red", "blue"))

ob_point

Description

Points are specified with x and y coordinates.

Polar points are ordinary points but are specified with an angle (theta) and a radial distance (r)

Usage

ob_point(
  x = 0,
  y = 0,
  alpha = numeric(0),
  color = character(0),
  fill = character(0),
  shape = numeric(0),
  size = numeric(0),
  stroke = numeric(0),
  style = S7::class_missing,
  id = character(0),
  ...
)

ob_polar(
  theta = S7::class_missing,
  r = numeric(0),
  alpha = numeric(0),
  color = character(0),
  fill = character(0),
  shape = numeric(0),
  size = numeric(0),
  stroke = numeric(0),
  style = S7::class_missing,
  id = character(0)
)

Arguments

Value

ob_point object

Additional properties

@auto_label

Gets x and y coordinates and makes a label "(x,y)"

@geom

A function that converts the object to a geom. Any additional parameters are passed to ggplot2::geom_point.

@length

The number of points in the ob_point object

@tibble

Gets a tibble::tibble containing parameters and styles used by ggplot2::geom_point.

@xy

Gets a 2-column matrix of the x and y coordinates of the ob_point object.

@centroid

ob_point at the average of the x and y values

@bounding_box

ob_rectangle that contains all the points in the object

@place

function to place point in relation to other objects

@label

function to create ob_label for points in the object

@aesthetics

returns class_aesthetics for ob_point

Examples

ggdiagram(theme = ggplot2::theme_minimal) +
  ob_point(x = -1:1, y = -1:1, color = "red") +
  ob_polar(theta = degree(seq(0, 330, 30)), r = 2, color = "blue")

The ob_polygon class

Description

A polygon is specified with an ob_point that contains at least 3 points, the start and the end. Any number of intermediate points are possible.

Usage

ob_polygon(
  p = S7::class_missing,
  label = character(0),
  vertex_radius = numeric(0),
  alpha = numeric(0),
  color = character(0),
  fill = character(0),
  linewidth = numeric(0),
  linetype = numeric(0),
  style = S7::class_missing,
  id = character(0),
  ...
)

Arguments

Details

If you wish to specify multiple polygons, you must supply a list of ob_point objects. When plotted, the ob_polygon function uses the ggforce::geom_shape function to create the geom.

Value

ob_polygon object

Additional properties

@aesthetics

A list of information about the object's aesthetic properties

@bounding_box

a rectangle that contains all the polygons

@geom

A function that returns the output of ggforce::geom_shape

@length

The number of polygons in the ob_polygon object

@point_at

A function that finds a point on the polygon at the specified angle.

@segment

The segments of each polygon

@tibble

Gets a tibble (data.frame) containing parameters and styles used by ggforce::geom_shape.

@center

Points at the centroids of each polygon

ob_rectangle class

Description

ob_rectangle class

Usage

ob_rectangle(
  center = S7::class_missing,
  width = numeric(0),
  height = numeric(0),
  east = S7::class_missing,
  north = S7::class_missing,
  west = S7::class_missing,
  south = S7::class_missing,
  northeast = S7::class_missing,
  northwest = S7::class_missing,
  southwest = S7::class_missing,
  southeast = S7::class_missing,
  angle = numeric(0),
  vertex_radius = numeric(0),
  label = character(0),
  alpha = numeric(0),
  color = character(0),
  fill = character(0),
  linewidth = numeric(0),
  linetype = numeric(0),
  style = S7::class_missing,
  x = numeric(0),
  y = numeric(0),
  id = character(0),
  ...
)

Arguments

Value

ob_rectangle object

Additional properties

@xy

returns a matrix of xy coordinates of center points

@aesthetics

A list of information about the object's aesthetic properties

@area

returns rectangle area

@bounding_box

returns the ob_rectangle that contains all the rectangles in the object

@perimeter

returns the rectangle perimeter

@side

returns the east, north, west, and south ob_segment of the rectangles

@length

returns the number of rectangles in the object

@geom

a function that returns a ggforce::geom_shape object

@normal_at

A function that finds a point perpendicular to the rectangle at angle theta at the specified distance.

@point_at

A function that finds a point on the rectangle at an angle theta

@tangent_at

A function that finds a tangent line on the rectangle. Uses point_at to find the tangent point at angle theta and then returns the tangent line at that point. If a point is supplied instead of an angle, the point is projected onto the ellipse and then the tangent line is found from there.

@tibble

Gets a tibble (data.frame) containing parameters and styles used by ggforce::geom_shape

Examples

ob_rectangle(center = ob_point(0,0), width = 3, height = 2)

Reuleaux polygon

Description

Reuleaux polygon

Usage

ob_reuleaux(
  center = ob_point(0, 0),
  n = 5,
  radius = 1,
  angle = 90,
  label = character(0),
  vertex_radius = numeric(0),
  alpha = numeric(0),
  color = "black",
  fill = character(0),
  linewidth = numeric(0),
  linetype = numeric(0),
  style = S7::class_missing,
  id = character(0),
  ...
)

Arguments

Value

ob_reuleaux object

Additional properties

@aesthetics

A list of information about the object's aesthetic properties

@angle_at

A function that finds the angle of the specified point in relation to the circle's center

@arc_at

A function that finds the arc at a specified angle

@arc_radius

The radius of the arcs used to construct the reuleaux object

@arcs

Returns the arcs of each reuleaux object

@bounding_box

a rectangle that contains all the reuleaux objects

@central_angle

The angle from the center to adjacent vertices of the reuleaux object

@chord_length

The length of each chord of the arcs used to construct the reuleaux object

@circumference

circumference of the reuleaux object

@circumscribed

Returns the circle that circumscribes the object

@geom

A function that converts the object to a geom. Any additional parameters are passed to ggforce::geom_shape.

@inscribed

Returns the circle that inscribes the object

@inscribed_angle

The angle of the arcs used to construct the reuleaux object

@length

The number of circles in the circle object

@normal_at

A function that finds a point that is perpendicular from the circle and at a specified distance

@point_at

A function that finds a point on the circle at the specified angle.

@polygon

a tibble containing information to create all the polygon points in a reuleaux object

@tangent_at

A function that finds the tangent line at the specified angle.

@vertices

Returns the vertices of the reuleaux object

Examples

ob_reuleaux(n = 3, fill = "royalblue", color = NA)

ob_segment class

Description

ob_segment class

Usage

ob_segment(
  p1 = S7::class_missing,
  p2 = S7::class_missing,
  label = character(0),
  label_sloped = TRUE,
  alpha = numeric(0),
  arrow_head = class_arrowhead(ggarrow::arrow_head_minimal(90)),
  arrow_fins = list(),
  arrowhead_length = 7,
  length_head = numeric(0),
  length_fins = numeric(0),
  color = character(0),
  lineend = numeric(0),
  linejoin = numeric(0),
  linewidth = numeric(0),
  linewidth_fins = numeric(0),
  linewidth_head = numeric(0),
  linetype = numeric(0),
  resect = numeric(0),
  resect_fins = numeric(0),
  resect_head = numeric(0),
  stroke_color = character(0),
  stroke_width = numeric(0),
  style = S7::class_missing,
  x = S7::class_missing,
  xend = S7::class_missing,
  y = S7::class_missing,
  yend = S7::class_missing,
  id = character(0),
  ...
)

Arguments

Value

ob_segment object

Additional properties

@aesthetics

A list of information about the segment's aesthetic properties

@bounding_box

a rectangle that contains all the segments

@distance

Distance between segment endpoints

@geom

A function that converts the object to a geom. Any additional parameters are passed to ggarrow::geom_arrow_segment.

@hatch

A function that puts hatch (tally) marks on segments. Often used to indicate which segments have the same length. The k parameter controls how many hatch marks to display. The height parameter controls how long the hatch mark segment is. The sep parameter controls the separation between hatch marks when k > 2. Additional parameters sent to ob_segment.

@length

The number of segments in the segment object

@line

The line object associated with the segment

@midpoint

A function that selects 1 or more midpoints of the ob_segment. The position argument can be between 0 and 1. Additional arguments are passed to ob_point.

@nudge

A function to move the segment by x and y units.

@set_label_x

A function that sets labels to have the same x coordinate. The position argument can be between 0 and 1, indicating how far along on the first segment the x coordinate is selected. If the x argument is set, the position argument is overridden, and the x-coordinate is set directly.

@set_label_y

A function that sets labels to have the same y coordinate. The position argument can be between 0 and 1, indicating how far along on the first segment the y coordinate is selected. If the y argument is set, the position argument is overridden, and the y-coordinate is set directly.

@tibble

Gets a tibble (data.frame) containing parameters and styles used by ggarrow::geom_arrow_segment

ob_shape_list

Description

makes a heterogeneous list of different ggdiagram objects

Usage

ob_shape_list(.data = list())

Arguments

Value

An object of ob_shape_list class. List of objects that can be converted to geoms

ob_style class

Description

ob_style class

Usage

ob_style(
  id = character(0),
  alpha = numeric(0),
  angle = numeric(0),
  arrow_head = list(),
  arrow_fins = list(),
  arrow_mid = list(),
  color = character(0),
  family = character(0),
  fill = character(0),
  fontface = character(0),
  hjust = numeric(0),
  justify = numeric(0),
  label.color = character(0),
  label.margin = list(),
  label.padding = list(),
  label.r = numeric(0),
  label.size = numeric(0),
  arrowhead_length = numeric(0),
  length_head = numeric(0),
  length_fins = numeric(0),
  length_mid = numeric(0),
  lineend = numeric(0),
  lineheight = numeric(0),
  linejoin = numeric(0),
  linewidth_fins = numeric(0),
  linewidth_head = numeric(0),
  linewidth = numeric(0),
  linetype = numeric(0),
  n = numeric(0),
  nudge_x = numeric(0),
  nudge_y = numeric(0),
  polar_just = numeric(0),
  resect = numeric(0),
  resect_fins = numeric(0),
  resect_head = numeric(0),
  shape = numeric(0),
  size = numeric(0),
  size.unit = numeric(0),
  straight = logical(0),
  stroke = numeric(0),
  stroke_color = character(0),
  stroke_width = numeric(0),
  text.color = character(0),
  vjust = numeric(0),
  ...
)

Arguments

Value

ob_style object

Variance object

Description

Creates double-headed arrow paths indicating variance

Usage

ob_variance(
  x,
  where = "north",
  theta = 50,
  bend = 0,
  looseness = 1,
  arrow_head = the$arrow_head,
  arrow_fins = the$arrow_head,
  resect = 2,
  ...
)

## S7 method for class <ggdiagram::centerpoint>
ob_variance(
  x,
  where = "north",
  theta = 50,
  bend = 0,
  looseness = 1,
  arrow_head = the$arrow_head,
  arrow_fins = the$arrow_head,
  resect = 2,
  ...
)

Arguments

Value

Returns an object of type ob_bezier

Methods

ob_variance is an S7 generic with methods available for the following classes:

• ggdiagram::centerpoint

Examples

theta <- degree(seq(0, 360 - 45, 45))
ggdiagram() +
{x <- ob_circle(ob_polar(theta, r = 3))} +
connect(x, lag_cycle(x, 3), resect = 2) +
ob_variance(x,
            label = ob_label(LETTERS[seq_along(c(theta))]),
            where = theta,
            looseness = 1.25)

Find point perpendicular to 2 points

Description

Find point perpendicular to 2 points

Usage

e1 %|-% e2

e1 %-|% e2

Arguments

Value

ob_point object

ob_point object

Examples

x <- ob_point(0,0)
y <- ob_point(1,1)
# Find point perpendicular to x and y going vertically first
x %|-% y
# Find point perpendicular to x and y going horizontally first
x %-|% y

Place an object a specified distance from another object

Description

Place an object a specified distance from another object

Usage

place(x, from, where = "right", sep = 1, ...)

Arguments

Value

object of same class as x

Convert hjust and vjust parameters from polar coordinates

Description

This function is how ob_label's vjust and hjust values are recalculated automatically when the polar_just parameter is specified.

Usage

polar2just(x, multiplier = NULL, axis = c("h", "v"))

Arguments

Value

ob_angle object

Examples

a <- "northwest"
polar2just(a, axis = "h")
polar2just(a, axis = "v")

Find projection of a point on an object (e.g., line or segment)

Description

Find projection of a point on an object (e.g., line or segment)

Usage

projection(p, object, ...)

Arguments

Value

ob_point

Make a variant of a function with alternate defaults

Description

Makes a copy of a function with new defaults. Similar to purrr::partial except that arguments with new defaults still accept input.

Usage

redefault(.f, ...)

Arguments

Value

function

Examples

squircle <- redefault(ob_ellipse, m1 = 4)
squircle(a = 3)

Objects exported from other packages

Description

These objects are imported from other packages. Follow the links below to see their documentation.

S7

prop(), props(), set_props()

Rescale an object in 2 dimensions

Description

Rescale an object in 2 dimensions

Usage

rescale(x, scale = 1, origin = ob_point(0, 0))

Arguments

Value

shape object

resect

Description

Shorten segments

Usage

resect(x, distance, ...)

Arguments

Value

object of same class as x

Rotate an object in 2 dimensions

Description

Rotate an object in 2 dimensions

Usage

rotate(x, theta, ..., origin = ob_point(0, 0))

Arguments

Value

shape object

Probability rounding

Description

Rounds to significant digits, removing leading zeros.

Usage

round_probability(
  p,
  accuracy = 0.01,
  digits = NULL,
  max_digits = NULL,
  remove_leading_zero = TRUE,
  round_zero_one = TRUE,
  phantom_text = NULL,
  phantom_color = NULL
)

Arguments

Value

a character vector

Examples

round_probability(c(0, .0012, .012, .12, .99, .992, .9997, 1), digits = 2)

Centering signed numbers

Description

A wrapper function for the signs::signs function. It adds a space to the right side of negative numbers so that it appear as if the minus sign does not affect the number's centering.

Usage

signs_centered(x, space = NULL, encoding = "UTF-8", ...)

Arguments

Value

a vector of numbers converted to characters

Create subscripts

Description

Create subscripts

Create superscript

Usage

subscript(x, subscript = seq(length(x)), output = c("markdown", "latex"))

superscript(x, superscript = seq(length(x)), output = c("markdown", "latex"))

Arguments

Value

text

string

Examples

subscript("X", 1)
superscript("A", 2)

unbind

Description

Converts an object with k elements into a list of k objects

Usage

unbind(x, ...)

Arguments

Value

a list of objects, each of length 1