add_ssffTrackDefinition: Define an SSFF track for the emuDB. (A copy of the emuR...

In humlab-speech/reindeer: This package extends the capabilities of emuR to work with speech data in a nordic climate

Define an SSFF track for the emuDB. (A copy of the emuR function)

Description

Add / List / Remove ssffTrackDefinition to / from / of emuDB. An ssffTrack (often simply referred to as a track) references data that is stored in the Simple Signal File Format (SSFF) in the according bundle folders. The two most common types of data are:

• complementary data that was acquired during the recording such as data acquired during electromagnetic articulographic (EMA) or electropalatography (EPG) recordings;

• derived data, i.e. data that was calculated from the original audio signal such as formant values and their bandwidths or the short-term Root Mean Square amplitude of the signal.

For more information on the structural elements of an emuDB see vignette(emuDB).

Usage

add_ssffTrackDefinition(
  emuDBhandle,
  name,
  columnName = NULL,
  fileExtension = NULL,
  onTheFlyFunctionName = NULL,
  onTheFlyParams = NULL,
  onTheFlyOptLogFilePath = NULL,
  verbose = TRUE,
  interactive = TRUE
)

Arguments

emuDBhandle	emuDB handle as returned by load_emuDB
name	name of ssffTrackDefinition
columnName	columnName of ssffTrackDefinition. If the onTheFlyFunctionName parameter is set and columnName isn't, the columnName will default to the first entry in wrasspOutputInfos[[onTheFlyFunctionName]]$tracks.
fileExtension	fileExtension of ssffTrackDefinitions. If the onTheFlyFunctionName parameter is set and fileExtension isn't, the fileExtension will default to the first entry in wrasspOutputInfos[[onTheFlyFunctionName]]$ext.
onTheFlyFunctionName	name of wrassp function to do on-the-fly calculation. If set to the name of a wrassp signal processing function, not only the emuDB schema is extended by the ssffTrackDefintion but also the track itself is calculated from the signal file and stored in the emuDB. See names(wrasspOutputInfos) for a list of all the signal processing functions provided by the wrassp package.
onTheFlyParams	a list of parameters that will be given to the function passed in by the onTheFlyFunctionName parameter. This list can easily be generated using the formals function on the according signal processing function provided by the wrassp package and then setting the parameter one wishes to change.
onTheFlyOptLogFilePath	path to optional log file for on-the-fly function
verbose	Show progress bars and further information
interactive	ask user for confirmation

See Also

emuR::add_ssffTrackDefinition

humlab-speech/reindeer documentation built on May 21, 2023, 4:43 p.m.