getSoundParams: Get and check currently possible sound parameters.

In playitbyr: Representing and exploring data through sound

Description

Gets all supported sound parameters, or checks a character vector of sound parameters for validity. This is used by sonaes and sonscaling to provide a minimal check that the names of their arguments are valid.

Usage

  getSoundParams(shapes = getShapeNames())

  checkSoundParams(paramnames, shapes = getShapeNames())

Arguments

shapes	The shapes to return the sound parameters of. The default is to get or check all currently available shapes (see link{getShapeNames}).
paramnames	A character vector of sound parameters to check for validity

Value

getSoundParams returns data.frame with the name of each parameter and the name of the shape it is a part of. checkSoundParams returns NULL if successful.

playitbyr documentation built on May 2, 2019, 6:08 p.m.