Skip to contents

Describes how unit-circle radian angles are rendered in plots and tables. Pass to any display function as the `display` argument.

Usage

circ_display(zero = pi/2, clockwise = TRUE, units = c("degrees", "radians"))

Arguments

zero

UC angle (radians) that maps to display 0. Default `pi/2` (geographic North at top — standard compass/clock layout). Use `0` to put a stimulus that lies at East (positive rel_x) at the top.

clockwise

Logical. `TRUE` (default) for clockwise-positive angles.

units

`"degrees"` (default) or `"radians"` for table outputs and degree label annotations.

Value

A `circ_display` list.

Examples

# Default: North at top, clockwise, degrees
circ_display()
#> $zero
#> [1] 1.570796
#> 
#> $clockwise
#> [1] TRUE
#> 
#> $units
#> [1] "degrees"
#> 
#> attr(,"class")
#> [1] "circ_display"

# Stimulus at East should appear at top
circ_display(zero = 0)
#> $zero
#> [1] 0
#> 
#> $clockwise
#> [1] TRUE
#> 
#> $units
#> [1] "degrees"
#> 
#> attr(,"class")
#> [1] "circ_display"

# Counterclockwise, radians
circ_display(clockwise = FALSE, units = "radians")
#> $zero
#> [1] 1.570796
#> 
#> $clockwise
#> [1] FALSE
#> 
#> $units
#> [1] "radians"
#> 
#> attr(,"class")
#> [1] "circ_display"