Skip to contents

Plot a timeline diagram for a siteswap

Source: R/generics.R
timeline.Rd

Produces a timeline (arc) diagram showing the trajectory of each prop across beats. Each arc represents a throw, coloured by prop. The x-axis labels show the throw heights from the siteswap sequence.

Usage

timeline(siteswap, n_cycles = 3, title = TRUE, subtitle = TRUE, ...)

Arguments

siteswap

Any siteswap object: a vanillaSiteswap, synchronousSiteswap, multiplexSiteswap, synchronousMultiplexSiteswap, or passingSiteswap.

n_cycles

Number of complete cycles to simulate (default 3). A warning is issued if not all props appear within the simulated range.

title

Logical. If TRUE (default), adds a title showing the siteswap sequence. Set to FALSE to suppress; override with ggplot2::labs() on the returned plot.

subtitle

Logical. If TRUE (default), adds a subtitle showing the siteswap type and number of props. Set to FALSE to suppress; override with ggplot2::labs() on the returned plot.

...

Additional arguments passed to methods.

Value

A ggplot2 object.

Examples

s <- vanillaSiteswap("531")
timeline(s)