sonlayer: Creating individual layers for sonify objects

View source: R/sonlayer.R

sonlayerR Documentation

Creating individual layers for sonify objects

Description

This function creates layers to be added onto a sonify object. It is most easy to use through the shape_ convenience functions, such as shape_scatter.

Usage

  sonlayer(shape = "scatter", data = NULL, mapping = NULL,
    ...)

Arguments

shape

A character string representing the overall style of the audio plot (analogous to geoms from the ggplot2 package).

data

The data.frame to be sonified for this layer. If blank, the data from the parent sonify object is used.

mapping

A sonaes object.

...

Additional options and settings specific to the shape

Conflicting defaults on sonlayer scalings

Each shape has its own default scalings (see link{.getShapeDef} to view these defaults. It's quite possible that some default scalings for a parameter differ between scalings; if this is the case, the default scaling for the earlier sonlayer type, as it appears in the $sonlayers slot of a sonify object, takes precedence.

Default scalings are, of course, ignored when they are explicitly declared; if you don't like the behavior of a default scaling you can always define your own (see sonscaling.

See Also

This functionality is most easily accessed through its shortcut functions, the shape_shapename functions, currently: shape_scatter


statisfactions/playitbyr documentation built on Jan. 27, 2024, 1:33 p.m.