playitbyr Getting Started Support--Help, Bugs, and Documentation GitHub Sonification Resources

scale_vol_exp {playitbyr}R Documentation

Continuous note volume scales

Description

These shortcut functions (with the notation scale_[sound parameter]_[scaling function]) are intended to be added onto a sonify object to specify how [data parameter] from the data (a column of the data) is to be mapped to sonic parameters (here, "vol", the proportion of the maximum volume of the note, as a number between 0 and 1).

Usage

  scale_vol_exp(soundlimits, limits = NULL, by = NULL, ...)

  scale_vol_continuous(soundlimits, limits = NULL,
    by = NULL, ...)

Arguments

...

Other parameters (currently ignored)

soundlimits

The limits of the sound parameter.

limits

The limits of the data to train, a numeric vector of length 2. All data values outside these limits are returned as NA. If NULL, the default, the function takes the minimum and maximum of the data

by

The unit to round the sound parameter to.

Details

_continuous scales are a linear scaling, whereas _exp is an exponential scale.

Value

A sonscaling object, to be used in sonify or added onto a sonify object.

See Also

shape_scatter, which has more information about this parameter